阅读980 返回首页    go 阿里云 go 技术社区[云栖]

查询策略与API绑定情况__流量控制相关接口_API_API 网关-阿里云

描述

查询指定分组指定环境下所有API的流控策略绑定情况

  • 此功能面向开放API的用户
  • 用于查询指定分组指定环境下，所有API的流控策略绑定概况
  • 非必填的参数，不传入则默认返回所有，分页返回

请求参数

名称 类型 是否必须 描述
Action String 是 操作接口名，系统规定参数，取值：DescribeApiTrafficControls
StageName String 是 指定要查询的环境。
  • RELEASE: 线上
  • TEST: 测试
GroupId String 是 指定要查询的分组
ApiIds String 否 指定要查询的API编号，支持输入多个，“,”分隔，最多支持100个
PageNumber Integer 否 指定要查询的页码，默认是1，起始是1
PageSize Integer 否 指定分页查询时每页行数，最大值100，默认值为10

返回参数

名称 类型 描述
RequestId String 本次请求编号
TotalCount Integer 返回结果的总条数
PageSize Integer 返回指定的每页条数
PageNumber Integer 返回指定的页码
ApiTrafficControls ApiTrafficControlItem 由 ApiTrafficControlItem 组成的数组格式，返回流控策略的信息项

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiTrafficControls
  2. &StageName=test
  3. &GroupId=0009db9c828549768a200320714b8930
  4. &<公共请求参数>

返回示例

XML格式

  1. <DescribeApiTrafficControlsResponse>
  2.     <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3.     <TotalCount>20</TotalCount>
  4.     <PageSize>10</PageSize>
  5.     <PageNumber>1</PageNumber>
  6.     <ApiTrafficControls>
  7.         <ApiTrafficControlItem>
  8.             <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>
  9.             <ApiName>testapi</ApiName>        
  10.             <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>
  11.             <TrafficControlName>backendsignature</TrafficControlName>
  12.             <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  13.         </ApiTrafficControlItem>
  14.     </ApiTrafficControls>
  15. </DescribeApiTrafficControlsResponse>

JSON格式

  1. {
  2.     "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3.     "TotalCount": "20",
  4.     "PageSize": "10",
  5.     "PageNumber": "1",
  6.     "ApiTrafficControls": {
  7.       "ApiTrafficControlItem": [
  8.         {
  9.           "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
  10.           "ApiName": "testapi",
  11.           "TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
  12.           "TrafficControlName": "backendsignature",
  13.           "BoundTime": "2016-07-23T08:28:48Z"
  14.         }
  15.       ]
  16.     }   
  17. }

最后更新：2016-11-23 17:16:10

  上一篇：go 查询策略下绑定的API__流量控制相关接口_API_API 网关-阿里云
  下一篇：go 查询流控策略列表__流量控制相关接口_API_API 网关-阿里云