简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
写入数据
对应的API调用形式为 POST/api/put BatchPutSummaryCallback，即数据写入的 统计模式。对应的API调用形式为 POST/api/put?summary=true BatchPutDetailsCallback，即数据写入的 详细模式。对应的API调用形式为 POST/api/put?details=true ...
请求结构
服务地址 OpenSearch为分区域部署，每个区域访问地址均不同，具体服务地址请查看访问应用-》基本详情中的API入口部分获取，切勿随便使用。通信协议 支持HTTP协议。部分区域（华北1、华北2、华东1、华东2、华南1）已支持HTTPS协议。请求方法...
SubmitQuery-提交查询
接口说明 仅适合提交中小型查询，执行时间不能超过 1 个小时 查询结果最多返回 10000 条 单个主账号下并发执行有限制，如同时提交多次查询会排队。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，Open...
DescribePurchasedApis-获取购买的 API 列表
CE5722A6-AE78-4741-A9B0-6C817D360510 PageSize integer 每页条目 10 TotalCount integer 返回结果的总条数 20 PurchasedApis object[]由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息 Visibility string 可见性，可选值：...
快速入门
本文以转账应用的发布、变更及监控为例，介绍运维管理模块中的各个组件的功能。前提条件 已创建 VPC 环境。已创建集群。步骤一：创建转账应用 在 应用管理 中创建名为 transfer money 的应用。技术栈选择 SOFABoot 2.0 版本。具体步骤参见 ...
支持资源组的云服务
是 application：应用 资源ID 统一转组API：MoveResources template：我的模板 资源ID 实时数仓Hologres hologram 是 是 instance：实例 资源ID 统一转组API：MoveResources 云备份（Cloud Backup）hbr 是 是 vault：仓库 资源ID 云服务转...
边缘应用账号权限对接
入参名称 数据类型 是否必须 入参描述 roles 复杂对象数组 是 权限列表,数组数量限制100 permissions 复杂对象数组 是 权限列表,数组数量限制100 具体复杂数组可参照接口文档：批量给角色关联权限接口 出参列表 出参名称 数据类型 出参描述...
SetDomainRuleGroup
使用数组转化的字符串格式表示。支持同时设置多个域名，格式：["<域名1>","<域名2>",……]。说明 您可以调用 DescribeDomainList 查询所有已接入WAF防护的域名。RuleGroupId Long 是 1012 为规则防护引擎设置要应用的防护规则组ID。取值：...
2023年
2023-09-25 优化 OpenAPI 扩展：支持通过代码组路径获取代码组ID的接口；支持代码库推送规则增删查接口；分页组件展示优化；功能 新增提交网络视图，便于追溯分支合并过程；新增仓库规范设置，支持限制仓库的分支命名规则与分支合并方向...
DescribeDeployedApis-查询已发布 API 列表
ID CEF72CEB-54B6-4AE8-B225-F876FF7BZ002 PageSize integer 返回指定的每页条数 10 TotalCount integer 返回结果的总条数 2 DeployedApis object[]由 DeployedApiItem 组成的数组格式，返回 API 的信息 Visibility string 可见性，可选值...
ListServerlessJobs-查询Serverless作业列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
查看、删除、移动、克隆、批量操作、代码搜索API
不能重复提交，需要进入API编辑页面，在右侧的 版本管理 里，废弃前一次提交的版本 发布 发布的前置条件是已提交，因此对于未提交API，需要先执行提交，再操作发布 发布的前置条件是已提交，因此对于未提交API，需要先执行提交，再操作发布...
基础功能
record：用于发送事件日志 sendPV：用于发送页面日志 arguments 参数为 action 中指定 API 的入参，格式是一个数组，数组内的元素顺序与 API 定义的入参顺序一致 1.2 示例/变更 SDK 的默认设置 aplus_queue.push({ action:'aplus....
HTTP API SQL接口开发手册
对于Java语言的应用开发，建议基于Java JDBC Driver构建时序引擎的应用程序，具体请参见 Java JDBC Driver开发手册。说明 单机版不支持此功能。请求路径与方法 请求路径 请求方法 描述/api/v2/sql POST 发送并执行SQL语句。请求内容 请求...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
2.6 人脸算法服务 API
本文档旨在定义与人脸算法服务交互的 API。1、方案介绍 人脸算法服为边缘服务器提供人脸算法支持，当云端下发人脸权限时，边缘服务器会通过预设的人脸算法获取权限对应的人脸特征值。2、通讯协议 驱动和边缘人脸算法间通过 HTTP 协议进行...
升级与降配
Web应用防火墙（Web Application Firewall，简称WAF）提供升级、降配功能，支持您根据业务的变化对已购买的WAF版本进行升级、对增值服务进行升降配。本文介绍如何升级或降配WAF。升级 支持升级的项目 升级服务版本 支持低版本升级到高版本...
Translation Memory-记忆库
List<GroupSearchWeightApiDTO>unitCount 语料数 long 查询语料内容 接口名称 POST/translatememory/queryTmUnit.json {"accessKey":"xxxxxaa","translationMemoryGroupId":001,"translationMemoryIds":[123,231,110],"transUnitIdList":...
导入数据模型
为了方便用户快速生成数据模型，API 网关支持通过 Proto 文件和 Swagger 文件来快速导入数据模型。操作步骤 登录 API 网关控制台。在左侧导航栏单击 API 发布>数据模型，进入数据模型页面。在页面右上角单击 导入数据模型，在弹出的窗口中...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
功能发布记录
本文介绍 Web 应用防火墙 WAF（Web Application Firewall）的产品功能和对应的文档动态。更多关于Web应用防火墙的产品动态信息，请参见 产品动态。2024年 发布日期 功能动态 发布说明 相关文档 2024-03-27 企业级客户多账号统一管理 只需要...
为MSE实例开启WAF防护
如果您的Web业务启用了阿里云微服务引擎（Microservices Engine，简称MSE）服务，您可以为MSE实例开启 Web应用防火墙（Web Application Firewall，简称WAF）防护，将Web业务流量引流到WAF 3.0进行安全防护。本文介绍如何为MSE实例开启WAF...
配额与限制
提交工单 抢占实例vCPU限额 800核 提交工单 按量付费转包年包月 不支持的实例规格（族）：t1、s1、s2、s3、c1、c2、m1、m2、n1、n2、e3 提交工单 ESS单个伸缩组可以设置的组内最大ECS实例数 2,000 到配额平台提交申请 操作系统 ACK支持添加...
数据服务
场景 数据服务资源组类型 独享数据服务资源组 公共数据服务资源组 实例模式 同租户访问RDS 数据服务API能够正常编辑和保存 数据服务API能够正常编辑和保存 跨租户访问RDS 数据服务API能够正常编辑和保存 保存API时报错：存在安全风险，需要...
查看及管理API
② 列表区 为您展示API名称、API_ID、API类型、API分组、应用数、负责人、模式、当前状态、运行环境、发布版本、发布信息等API详情。③ 操作区 您可对API执行发布、版本管理、转让负责人、删除操作。发布：选择需要发布的已提交版本，将API...
CreateCommitWithMultipleFiles-多文件变更提交
master commitMessage string 否 提交说明信息 auto actions object[]是 操作数组，每个 action 代表一个文件的操作 action string 否 操作类型 create：创建文件 delete：删除文件 move：移动文件 update：更新文件 create filePath ...
数据服务入门
DataWorks数据服务的主要目标是为个人、团队和企业构建统一的数据服务总线，帮助用户统一管理面向内外部的API服务。例如，您可以将查询数据表功能快速的生成对应的API，或将已有的API注册至数据服务平台进行统一发布和管理。本文以MySQL...
API安全
API安全模块支持自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务中开放的API资产，检测API风险（例如敏感数据泄露、内部接口暴露等），并通过报表还原API异常事件，提供详细的风险处理建议和API生命周期管理...
设置账户安全
在顶部菜单栏，选择Web应用防火墙实例的资源组和地域（中国内地、非中国内地）。在左侧导航栏，选择 场景防护>账户安全。在 账户安全 页面，单击 创建接口。如果您是第一次进入 账户安全 页面，请跳过该步骤。说明 每个WAF实例最多可以添加...
后端签名插件
抽象一下就是将串（StringToSign）使用UTF-8解码后得到Byte数组，然后使用加密算法对Byte数组进行加密，然后使用Base64算法进行编码，形成最终的签名。6.调试模式 为了方便后端签名接入与调试，可以开启 Debug 模式进行调试，具体方法如下...
RestAPI Reader最佳实践
实践3：读取一个接口数据，该接口为POST类型的RestAPI接口 示例场景：接口定义 本实践示例的场景为读取一个RESTful接口数据并写入一个MaxCompute分区表中，其中使用的示例RESTful接口为一个自建的测试POST接口，本示例的接口详情如下。...
使用限制
旁路转推任务数 单频道最多并发3个任务，单个应用最多并发100个任务，支持提交工单提升。录制任务数 单频道最多并发3个任务，单个应用最多并发100个任务，支持提交工单提升。频道时长 默认24小时，支持提交工单提升。应用个数 默认100个，...
专享实例
目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示：实例规格 最大入访每秒请求数（RPS）最大入访连接数 最大入访每秒新建连接数（CPS）最大出访连接池大小 最大公网入访带宽（bps）最大公网出访带宽（bps）SLA api.s1....
为ALB实例开启WAF防护
如果您的Web业务启用了阿里云应用型负载均衡（Application Load Balancer，简称ALB），您可以为ALB实例开启 Web应用防火墙（Web Application Firewall，简称WAF）防护，将Web业务流量引流到WAF进行安全防护。本文介绍如何为ALB实例开启WAF...
通过脚本模式生成API
数据服务支持通过脚本模式或向导模式生成API，相对于向导模式，您可以自行编写API的查询SQL，支持多表关联、复杂查询和聚合函数等功能，满足您个性化查询需求。本文为您介绍如何通过脚本模式生成API。前提条件 配置API前，请先在 工作空间...
写入数据
请求路径和方法 请求路径 请求方法 描述/api/put POST 一次写入多个数据点。请求参数 名称 类型 是否必需 描述 默认值 举例 summary 无类型 否 是否返回摘要信息。false/api/put?summary details 无类型 否 是否返回详细信息。false/api/...
- 产品推荐
- 这些文档可能帮助您