Query the throttling policies bound to the APIs - Developer Guide| Alibaba Cloud Documentation Center

Description

For querying the throttling policies bound to all the APIs in the specified stage of the specified API group.

This function is intended for API activators.
This interface is used to query the throttling policies bound to all the APIs in the specified stage of the specified API group.
If you do not input optional parameters, the system returns the signature keys bound to all the APIs in the specified stage of an API group by page.

Request parameters

Name	Type	Required?	Description
Action	String	Yes	Operation interface name, which is a required parameter; value: DescribeApiTrafficControls.
StageName	String	Yes	Name of the stage you want to query. RELEASE: Online TEST: Test
GroupId	String	Yes	ID of the API group you want to query.
ApiIds	String	No	IDs of the APIs you want to query. If multiple API IDs are input, they must be separated by a comma (,). Up to 100 API IDs can be input.
PageNumber	Integer	No	The page number specified for query; default value: 1; the starting number: 1.
PageSize	Integer	No	Number of lines per page set at paging query; maximum value: 100; default value: 10.

Return parameters

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

Examples

Request example

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiTrafficControls
&StageName=test
&GroupId=0009db9c828549768a200320714b8930
&<Public request parameters>

Response example

XML format

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

JSON format

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