条件查询流控策略列表及详情信息（DescribeTrafficControls）

描述

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

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

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：DescribeTrafficControls
TrafficControlId	String	否	流控策略ID
GroupId	String	否	指定的分组编号，必须和ApiId、StageName一起查询
ApiId	String	否	指定的API编号，必须和GroupId、StageName一起查询
StageName	String	否	环境名称，必须和GroupId、ApiId一起查询，可选值： RELEASE：线上 TEST：测试
TrafficControlName	String	否	流控策略名称
PageSize	Integer	否	指定分页查询时每页行数，最大值100，默认值为10
PageNumber	Integer	否	指定要查询的页码，默认是1，起始是1

返回参数

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

示例

请求示例

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

返回示例

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>

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"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}