Description
For querying the throttling policies bound to a specified API.
- This function is intended for API activators.
- This interface is used to query the throttling policies bound to a specified API.
Request parameters
Name | Type | Required? | Description |
---|---|---|---|
Action | String | Yes | Operation interface name, which is a required parameter; value: DescribeTrafficControlsByApi. |
GroupId | String | Yes | ID of the API group to which the API you want to query belongs. |
ApiId | String | Yes | ID of the API you want to query. |
StageName | String | Yes | Name of the stage you want to query.
|
Return parameters
Name | Type | Description |
---|---|---|
RequestId | String | ID of the current request. |
TrafficControlItems | TrafficControlItem | Returned information items of throttling policies, in an array consisting of TrafficControlItem. |
Examples
Request example
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControlByApi
&GroupId=0009db9c828549768a200320714b8930
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=test
&<Public request parameters>
Response example
XML
format
<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>
JSON
format
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
"TrafficControlItems": {
"TrafficControlItem": [
{
"TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
"TrafficControlName": "mysecret",
"BoundTime": "2016-07-23T08:28:48Z"
}
]
}
}