首页 API 网关 开发指南 API参考指南 API目录 监控 DescribeApiTrafficControls - 查询API流控策略绑定概况

DescribeApiTrafficControls - 查询API流控策略绑定概况

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

接口说明

  • 此功能面向开放API的用户
  • 非必填的参数,不传入则默认返回所有,分页返回

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiTrafficControlsRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
StageNamestring

指定要查询的环境。

  • RELEASE:线上
  • TEST:测试
RELEASE
GroupIdstring

指定要查询的分组

0009db9c828549768a200320714b8930
ApiIdsstring

指定要查询的API编号,支持输入多个,“,”分隔,最多支持100个

123,234
PageNumberinteger

指定要查询的页码,默认是1,起始是1

1
PageSizeinteger

指定分页查询时每页行数,最大值100,默认值为10

20

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

20
ApiTrafficControlsarray

由 ApiTrafficControlItem 组成的数组格式,返回流控策略的信息项

object
BoundTimestring

流控策略绑定时间

2016-07-23T08:28:48Z
ApiIdstring

API编号

46fbb52840d146f186e38e8e70fc8c90
TrafficControlIdstring

流控策略ID

dd05f1c54d6749eda95f9fa6d491449a
TrafficControlNamestring

流控策略名称

backendsignature
ApiNamestring

API名称

testapi

示例

正常返回示例

JSON格式

{
    "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
    "TotalCount": "20",
    "PageSize": "10",
    "PageNumber": "1",
    "ApiTrafficControls": {
      "ApiTrafficControlItem": [
        {
          "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
          "ApiName": "testapi",
          "TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
          "TrafficControlName": "backendsignature",
          "BoundTime": "2016-07-23T08:28:48Z"
        }
      ]
    }   
}

XML格式

<DescribeApiTrafficControlsResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
    <TotalCount>20</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <ApiTrafficControls>
        <ApiTrafficControlItem>
            <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>
            <ApiName>testapi</ApiName>        
            <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>
            <TrafficControlName>backendsignature</TrafficControlName>
            <BoundTime>2016-07-23T08:28:48Z</BoundTime>
        </ApiTrafficControlItem>
    </ApiTrafficControls>
</DescribeApiTrafficControlsResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 API 网关 相关技术圈