edit-icon download-icon

Query the list of throttling policies

Last Updated: Dec 22, 2017

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

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

Response example

XML format

  1. <DescribeTrafficControlsResponse>
  2. <TotalCount>1</TotalCount>
  3. <PageSize>10</PageSize>
  4. <PageNumber>1</PageNumber>
  5. <RequestId>93D91A99-F093-4596-87BA-3C4FBFD3FD8A</RequestId>
  6. <TrafficControls>
  7. <TrafficControl>
  8. <TrafficControlId>cfed6c970d45481dbe136d6b5ac68c41</TrafficControlId>
  9. <ApiDefault>20000</ApiDefault>
  10. <TrafficControlUnit>Minute</TrafficControlUnit>
  11. <TrafficControlName>wulingtestq1</TrafficControlName>
  12. <ModifiedTime>2016-01-27T10:34:38Z</ModifiedTime>
  13. <UserDefault>15000</UserDefault>
  14. <AppDefault>8000</AppDefault>
  15. <Description>test</Description>
  16. <CreateTime>2016-01-27T10:19:39Z</CreateTime>
  17. <SpecialPolicies>
  18. <SpecialPolicy>
  19. <SpecialType>User</SpecialType>
  20. <Specials>
  21. <Special>
  22. <TrafficValue>100</TrafficValue>
  23. <SpecialKey>test_wg@aliyun.com</SpecialKey>
  24. </Special>
  25. </Specials>
  26. </SpecialPolicy>
  27. <SpecialPolicy>
  28. <SpecialType>App</SpecialType>
  29. <Specials>
  30. <Special>
  31. <TrafficValue>100</TrafficValue>
  32. <SpecialKey>12345678</SpecialKey>
  33. </Special>
  34. </Specials>
  35. </SpecialPolicy>
  36. </SpecialPolicies>
  37. </TrafficControl>
  38. </TrafficControls>
  39. </DescribeTrafficControlsResponse>

JSON format

  1. {
  2. "TotalCount": 1,
  3. "PageSize": 10,
  4. "PageNumber": 1,
  5. "RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
  6. "TrafficControls": {
  7. "TrafficControl": [
  8. {
  9. "TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
  10. "ApiDefault": 20000,
  11. "TrafficControlUnit": "Minute",
  12. "TrafficControlName": "wulingtestq1",
  13. "ModifiedTime": "2016-01-27T10:34:38Z",
  14. "UserDefault": 15000,
  15. "AppDefault": 8000,
  16. "Description": "test",
  17. "CreateTime": "2016-01-27T10:19:39Z",
  18. "SpecialPolicies": {
  19. "SpecialPolicy": [
  20. {
  21. "SpecialType": "User",
  22. "Specials": {
  23. "Special": [
  24. {
  25. "TrafficValue": 100,
  26. "SpecialKey": "test_wg@aliyun.com"
  27. }
  28. ]
  29. }
  30. },
  31. {
  32. "SpecialType": "App",
  33. "Specials": {
  34. "Special": [
  35. {
  36. "TrafficValue": 100,
  37. "SpecialKey": "12345678"
  38. }
  39. ]
  40. }
  41. }
  42. ]
  43. }
  44. }
  45. ]
  46. }
  47. }
Thank you! We've received your feedback.