简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
DescribePurchasedApis-获取购买的 API 列表
CE5722A6-AE78-4741-A9B0-6C817D360510 PageSize integer 每页条目 10 TotalCount integer 返回结果的总条数 20 PurchasedApis object[]由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息 Visibility string 可见性，可选值：...
DescribeApisByIpControl-查询IP访问控制绑定的API
20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId string API 编号 3b81fd160f5645e097cc...
DescribeApiIpControls-查询API的IP访问控制绑定情况
10 TotalCount integer 返回结果的总条数 1 ApiIpControls object[]由 ApiIpControlItem 组成的数组格式，返回 IP 访问控制的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e38e8e70fc8...
DescribeApisByTrafficControl-查询指定流控策略下已...
20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId string API 编号 3b81fd160f5645e097cc...
DescribeHistoryApis-查询API发布版本定义列表
6C87A26A-6A18-4B8E-8099-705278381A2C PageSize integer 指定分页查询时每页行数，最大值 50，默认值为 10 10 TotalCount integer 返回结果的总条数 20 ApiHisItems object[]由 ApiHisItem 组成的数组格式，返回 API 的信息 Status string...
DescribeDeployedApis-查询已发布 API 列表
ID CEF72CEB-54B6-4AE8-B225-F876FF7BZ002 PageSize integer 返回指定的每页条数 10 TotalCount integer 返回结果的总条数 2 DeployedApis object[]由 DeployedApiItem 组成的数组格式，返回 API 的信息 Visibility string 可见性，可选值...
DescribeApiSignatures-查询API签名密钥绑定情况
10 TotalCount integer 返回结果的总条数 20 ApiSignatures object[]由 ApiSignatureItem 组成的数组格式，返回签名密钥的信息项 BoundTime string 后端签名密钥绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146f186e...
DescribeApiTrafficControls-查询API流控策略绑定概况
10 TotalCount integer 返回结果的总条数 20 ApiTrafficControls object[]由 ApiTrafficControlItem 组成的数组格式，返回流控策略的信息项 BoundTime string 流控策略绑定时间 2016-07-23T08:28:48Z ApiId string API 编号 46fbb52840d146...
Web
返回结果说明：当您推了音频流，返回数组中userId为字符串0的一项，是自己的音频信息。当您订阅了其他用户的音频流，该数组中会包含订阅用户的音频信息。具体数组各项的信息如下所示：返回值 类型 描述 userId String 订阅用户userId，用户...
DescribeApisBySignature-查询签名密钥绑定的API列表
10 TotalCount integer 返回结果的总条数 20 ApiInfos object[]由 ApiInfo 组成的数组格式，返回 API 的信息项 BoundTime string 绑定时间 2016-07-23T08:28:48Z Visibility string 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 PUBLIC ApiId...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
SpecialPolicy
SpecialPolicies 描述"class="reference-link">描述 特殊流控策略信息项的类型 节点名"class="reference-link">节点名 SpecialPolicy 子节点...应用 USER：用户 Specials Special 由 Special 组成的数组格式，返回特殊流控策略数据项信息
TrafficControl
UserDefault Integer 每个用户默认的流控值 AppDefault Integer 每个APP默认的流控值 SpecialPolicies SpecialPolicy 由 SpecialPolicy 组成的数组格式，返回特殊流控策略信息 CreatedTime String 创建时间（格林威治时间）ModifiedTime ...
参数映射与校验规则
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...
API概览
系统为开发者提了一套REST风格的WebAPI服务。本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为URL请求串及请求Header参数两部分，所有请求均必须包含该两...
DescribeRegions-查询支持的区域
名称 类型 描述 示例值 object RequestId string 本次请求编号 36BBBAD4-1CFB-489F-841A-8CA52EEA787E Regions object[]由 Region 组成的数组格式，返回区域信息 cn-huhehaote RegionEndpoint string 区域服务接入点 apigateway....
DescribeTrafficControls-查询流控策略列表及详情
接口说明 此功能面向开放 API 的用户 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略 调试 您可以在OpenAPI Explorer...
DescribeTrafficControlsByApi-查询API绑定的流控策略
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
DescribeSignaturesByApi-查询API绑定的后端签名密钥
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
DescribeSystemParameters-查询系统参数列表
接口说明 此功能面向开放 API 的用户 此接口返回定义 API 时可选择接收的系统参数列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DescribeApps-查询应用列表
接口说明 此功能面向开放 API 的用户 API 开放者可通过 AppId 或者阿里云登录账号查询 app 信息，进而操作授权 每个用户在每个 Region 每天调用次数上限为 200 次 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
后端签名插件
抽象一下就是将串（StringToSign）使用UTF-8解码后得到Byte数组，然后使用加密算法对Byte数组进行加密，然后使用Base64算法进行编码，形成最终的签名。6.调试模式 为了方便后端签名接入与调试，可以开启 Debug 模式进行调试，具体方法如下...
DescribeDatasetList-查询数据集列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeIpControlPolicyItems-查询IP访问控制策略...
接口说明 此功能面向 API 提供者 可支持策略 ID 过滤 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM...
ModifyDomain
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ModifyDomain 要执行的操作。取值：...
DescribeAppAttributes-查询APP列表信息
接口说明 此功能面向调用 API 的用户 AppId 可选择性传入 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在...
DescribePlugins-查询插件列表
接口说明 支持分页 支持按照插件业务类型查询 支持按照插件 ID 查询 支持按照插件名称查询 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
CreateIpControl-新增IP访问控制
接口说明 调用本接口之前，您需要了解：此功能面向 API 提供者。IP 访问控制创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。具体的 IP 策略可以在创建 IP 控制时添加 当 IP 访问控制下策略为空时，该策略无效。...
DescribeIpControls-查询IP访问控制列表
接口说明 此功能面向 API 提供者 用于查询某 Region 下的 IP 访问控制列表，Region 为系统参数 可根据控制 ID，名称，类型等过滤 该接口不含具体的策略，如果需要查询详细策略，请用 查询 IP 访问控制策略列表 接口 调试 您可以在OpenAPI ...
CreateDomain
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 CreateDomain 要执行的操作。取值：...
DescribeSignatures-查询后端签名密钥列表
接口说明 此功能面向开放 API 的用户 用于查询某 Region 下的后端签名密钥列表，Region 为系统参数 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
DescribeVpcAccesses-查询授权的VPC列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
新功能发布记录
全部 2021-06 功能名称 功能描述 发布地域 相关文档 新增BasePath 支持在分组上设置BasePath，分组内所有API访问都需要组合BasePath与API自身的Path 全部 Swagger导入支持Array数组 Swagger导入支持Array数组 全部 全链路日志 支持全链路...
DescribeHybridCloudResources-查询混合云CNAME接入...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您