首页 API 网关 开发指南 API参考指南 API目录 流控插件(经典网络实例) DescribeTrafficControlsByApi - 查询API绑定的流控策略

DescribeTrafficControlsByApi - 查询API绑定的流控策略

查询指定API已绑定的流控策略。

接口说明

  • 此功能面向开放API的用户

调试

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

调试

授权信息

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

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

请求参数

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

指定要查询的API所属分组

0009db9c828549768a200320714b8930
ApiIdstring

指定要查询的Api编号

3b81fd160f5645e097cc8855d75a1cf6
StageNamestring

指定要查询的环境。

  • RELEASE:线上
  • TEST:测试
RELEASE

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

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

由 TrafficControlItem 组成的数组格式,返回策略的信息项

object
TrafficControlItemIdstring

流控策略ID

dd05f1c54d6749eda95f9fa6d491449a
BoundTimestring

绑定时间

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

流控策略名称

mysecret

示例

请求示例

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

正常返回示例

JSON格式

{
    "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
    "TrafficControlItems": {
      "TrafficControlItem": [
        {
          "TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
          "TrafficControlName": "mysecret",
          "BoundTime": "2016-07-23T08:28:48Z"
        }
      ]
    }   
}

XML格式

<DescribeTrafficControlByApiResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
    <TrafficControlItems>
        <TrafficControlItem>
            <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>        
            <TrafficControlName>mysecret</TrafficControlName>
            <BoundTime>2016-07-23T08:28:48Z</BoundTime>
        </TrafficControlItem>
    </TrafficControlItems>
</DescribeTrafficControlByApiResponse>

错误码

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

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