Query the list of throttling policies - Developer Guide| Alibaba Cloud Documentation Center

Description

For querying the list and details of custom throttling policies. Criteria queries are supported.

This function is intended for API activators.
This interface can be used to query all created throttling policies and the special throttling policies under the created policies, including detailed information.
This interface supports criteria queries. For example, you can query the throttling policies bound to a specified interface or in a specified stage.

Request parameters

Name	Type	Required?	Description
Action	String	Yes	Operation interface name, which is a required parameter; value: DescribeTrafficControls.
TrafficControlId	String	No	ID of a specified throttling policy.
GroupId	String	No	Specified group ID, which must be used together with ApiId and StageName.
ApiId	String	No	Specified API ID, which must be used together with GroupId and StageName.
StageName	String	No	Stage name, which must be used together with GroupId and ApiId; values: RELEASE: Online TEST: Test
TrafficControlName	String	No	Throttling policy name.
PageSize	Integer	No	Number of lines per page set at paging query; maximum value: 100; default value: 10.
PageNumber	Integer	No	The page number specified for query; default value: 1; the starting number: 1.

Return parameters

Name	Type	Description
RequestId	String	ID of the current request.
TotalCount	Integer	Total number of returned results.
PageNumber	Integer	Page number specified to be returned.
PageSize	Integer	Specified total number of results returned per page.
TrafficControls	TrafficControl	Returned throttling policy information, in an array consisting of TrafficControl.

Examples

Request example

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControls
&TrafficControlId=tf123456
&TrafficControlName=throttling test
&GroupId=0009db9c828549768a200320714b8930
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=RELEASE
&<Public request parameters>

Response example

XML format

<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 format

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