DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
DescribePluginApis-查询插件绑定的API列表
查询插件绑定的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
SetApisAuthorities-给多个API添加APP访问权限
接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribeApisByBackend-根据后端查询 API 列表
查询使用该后端服务创建的草稿态API，或已发布在某个环境上的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息...
DescribeDeployedApis-查询已发布 API 列表
查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
DeleteApi-删除 API 定义
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
ImportOAS-通过OAS导入API
92af1abffc2443eaa2b815fdbd9c13f1 ApiOperation string 该 API 是创建（CREATE）或修改（MODIFY）CREATE FailedApis object[]预检失败的 API 信息 Path string 创建 API 时配置的请求路径/st1 HttpMethod string 创建 API 时配置的 HTTP ...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribeAuthorizedApis-查询已授权的API列表
查询指定 APP 已授权的API列表，即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
DescribeApiLatencyData-查询API监控数据中对响应时间...
接口说明 查询指定 API 的监控信息：Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
DescribePurchasedApis-获取购买的 API 列表
获取在云市场购买的 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
DescribeHistoryApis-查询API发布版本定义列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
修改VPC授权信息，并且更新关联的API的元信息
修改VPC授权信息并更新关联的API元信息。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的...
CreateTrafficControl-创建流控策略
接口说明 此功能面向开放 API 的用户 策略创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
SetTrafficControlApis-添加指定流控策略与API的绑定
接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
DescribeApiTrafficData-查询API监控数据中流量统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DescribeApiQpsData-查询API监控数据中对QPS的统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DescribePurchasedApiGroups-获取购买的API分组列表
获取云市场购买的 API 分组列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
SetAppsAuthToApiProduct-批量授权多个APP给指定API...
批量授权多个APP给指定的API产品 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
ModifyApiGroupInstance-修改api分组所属的实例
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
SwitchApi-切换指定环境中正在运行中的API定义
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
CreatePlugin-创建API网关插件
接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量，不同类型，上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。调试 您可以在OpenAPI ...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DescribePurchasedApiGroup-获取购买的 API 组
获取云市场购买的 API 分组详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
CreateIpControl-新增IP访问控制
IP 访问控制创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。具体的 IP 策略可以在创建 IP 控制时添加 当 IP 访问控制下策略为空时，该策略无效。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的...
QueryPriceEntityList-商品定价对象列表查询
本API是用来查询一个商品下有哪些定价对象。定价对象是用来计量和计算费用的最小产品能力。接口说明 本 API 是用来查询一个商品下有哪些定价对象。定价对象是用来计量和计算费用的最小产品能力。调试 您可以在OpenAPI Explorer中直接运行该...
DescribeApisByApp-根据应用查询API列表
根据APP查询关联的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
跨域资源访问（CORS）
因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览器在发送options请求时，不会带上X-Ca-Stage参数，会导致请求不到指定环境的API，插件也就无法生效了。如果API发布的是测试环境，可以...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
根据APP查询有权限的API产品列表
根据APP查询有权限的API产品列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
更新VPC授权会异步更新关联的发布中的API，该API用来查询这些API的更新进度。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
为什么要定义参数？
参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。
DeletePlugin-删除插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeletePlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 指定要删除的 API 网关插件的 ID 9a3f1a5279434f2ba74ccd91c295af9f Tag object[]否 ...
- 产品推荐
- 这些文档可能帮助您