edit-icon download-icon

Query the throttling policies bound to an API

Last Updated: Dec 22, 2017

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.
  • RELEASE: Online
  • TEST: Test

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

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControlByApi
  2. &GroupId=0009db9c828549768a200320714b8930
  3. &ApiId=3b81fd160f5645e097cc8855d75a1cf6
  4. &StageName=test
  5. &<Public request parameters>

Response example

XML format

  1. <DescribeTrafficControlByApiResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TrafficControlItems>
  4. <TrafficControlItem>
  5. <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>
  6. <TrafficControlName>mysecret</TrafficControlName>
  7. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  8. </TrafficControlItem>
  9. </TrafficControlItems>
  10. </DescribeTrafficControlByApiResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "TrafficControlItems": {
  4. "TrafficControlItem": [
  5. {
  6. "TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
  7. "TrafficControlName": "mysecret",
  8. "BoundTime": "2016-07-23T08:28:48Z"
  9. }
  10. ]
  11. }
  12. }
Thank you! We've received your feedback.