DescribeTrafficControls - 查询流控策略列表及详情

查询用户自定义的流控策略列表及详情信息,支持条件查询。

接口说明

  • 此功能面向开放API的用户
  • 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略,包括详细信息
  • 此接口还可以支持条件查询,如查询指定接口所绑定的流控策略,如查询指定环境下的流控策略

调试

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

调试

授权信息

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

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

请求参数

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

流控策略ID

tf123456
GroupIdstring

指定的分组编号,必须和ApiIdStageName一起查询

0009db9c828549768a200320714b8930
ApiIdstring

指定的API编号,必须和GroupIdStageName一起查询

3b81fd160f5645e097cc8855d75a1cf6
StageNamestring

环境名称,必须和GroupIdApiId一起查询 ,可选值:

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

流控策略名称

流控测试
PageNumberinteger

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

93D91A99-F093-4596-87BA-3C4FBFD3FD8A
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
TrafficControlsarray

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

object
UserDefaultinteger

每个用户默认的流控值

15000
ApiDefaultinteger

每个API默认流控值

20000
ModifiedTimestring

上一次修改时间(格林威治时间)

2016-01-27T10:34:38Z
Descriptionstring

流控策略描述

test
TrafficControlUnitstring

流控策略单位,可选值:

  • MINUTE:分钟
  • HOUR:小时
  • DAY:天
Minute
TrafficControlNamestring

流控策略名称

wulingtestq1
AppDefaultinteger

每个app默认的流控值

8000
TrafficControlIdstring

流控策略ID

cfed6c970d45481dbe136d6b5ac68c41
CreatedTimestring

创建时间(格林威治时间)

2016-01-27T10:19:39Z
SpecialPoliciesarray

由 SpecialPolicy 组成的数组格式,返回特殊流控策略信息

object
SpecialTypestring

特殊流控类型,可选值:

  • APP:应用
  • USER:用户
USER
Specialsarray

由 Special 组成的数组格式,返回特殊流控策略数据项信息

object
TrafficValueinteger

流控值

100
SpecialKeystring

根据SpecialType对应的AppId或者是用户账号

test_wg@aliyun.com

示例

请求示例

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControls
&TrafficControlId=tf123456
&TrafficControlName=流控测试
&GroupId=0009db9c828549768a200320714b8930
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=RELEASE
&<公共请求参数>

正常返回示例

JSON格式

{
    "TotalCount": 1,
    "PageSize": 10,
    "PageNumber": 1,
    "RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
    "TrafficControls": {
        "TrafficControl": [
            {
                "TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
                "ApiDefault": 20000,
                "TrafficControlUnit": "Minute",
                "TrafficControlName": "wulingtestq1",
                "ModifiedTime": "2016-01-27T10:34:38Z",
                "UserDefault": 15000,
                "AppDefault": 8000,
                "Description": "test",
                "CreateTime": "2016-01-27T10:19:39Z",
                "SpecialPolicies": {
                    "SpecialPolicy": [
                        {
                            "SpecialType": "User",
                            "Specials": {
                                "Special": [
                                    {
                                        "TrafficValue": 100,
                                        "SpecialKey": "test_wg@aliyun.com"
                                    }
                                ]
                            }
                        },
                        {
                            "SpecialType": "App",
                            "Specials": {
                                "Special": [
                                    {
                                        "TrafficValue": 100,
                                        "SpecialKey": "12345678"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}

XML格式

<DescribeTrafficControlsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>93D91A99-F093-4596-87BA-3C4FBFD3FD8A</RequestId>
    <TrafficControls>
        <TrafficControl>
            <TrafficControlId>cfed6c970d45481dbe136d6b5ac68c41</TrafficControlId>
            <ApiDefault>20000</ApiDefault>
            <TrafficControlUnit>Minute</TrafficControlUnit>
            <TrafficControlName>wulingtestq1</TrafficControlName>
            <ModifiedTime>2016-01-27T10:34:38Z</ModifiedTime>
            <UserDefault>15000</UserDefault>
            <AppDefault>8000</AppDefault>
            <Description>test</Description>
            <CreateTime>2016-01-27T10:19:39Z</CreateTime>
            <SpecialPolicies>
                <SpecialPolicy>
                    <SpecialType>User</SpecialType>
                    <Specials>
                        <Special>
                            <TrafficValue>100</TrafficValue>
                            <SpecialKey>test_wg@aliyun.com</SpecialKey>
                        </Special>
                    </Specials>
                </SpecialPolicy>
                <SpecialPolicy>
                    <SpecialType>App</SpecialType>
                    <Specials>
                        <Special>
                            <TrafficValue>100</TrafficValue>
                            <SpecialKey>12345678</SpecialKey>
                        </Special>
                    </Specials>
                </SpecialPolicy>
            </SpecialPolicies>
        </TrafficControl>
    </TrafficControls>
</DescribeTrafficControlsResponse>

错误码

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

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