Querying the Request Throttling Policy List
Function
This API is used to query all request throttling policies.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
| Request Method | URI |
|---|---|
| GET | /v1.0/apigw/throttles[?page_size, page_no, id, name] |
- A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
- Query conditions include: id, name, page_size, and page_no.
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| id | No | String | ID of a request throttling policy |
| name | No | String | Name of the request throttling policy |
| page_size | No | Integer | Number of records displayed on each page. The default value is 20. |
| page_no | No | Integer | Page number. The default value is 1. |
| precise_search | No | String | Parameter name (name) for exact matching |
Response
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Number of request throttling policies that match the query conditions |
| size | Integer | Length of the returned request throttling policy list |
| throttles | Dictionary | Request throttling policy list |
| Parameter | Type | Description |
|---|---|---|
| id | String | ID of a request throttling policy |
| name | String | Name of the request throttling policy |
| api_call_limits | Integer | Maximum number of times an API can be accessed within a specified period |
| user_call_limits | Integer | Maximum number of times the API can be accessed by a user within the same period |
| app_call_limits | Integer | Maximum number of times the API can be accessed by an app within the same period |
| ip_call_limits | Integer | Maximum number of times the API can be accessed by an IP address within the same period |
| time_interval | Integer | Period of time for limiting the number of API calls |
| time_unit | String | Time unit for limiting the number of API calls |
| remark | String | Description of the request throttling policy |
| create_time | Timestamp | Time when the request throttling policy is created |
| is_include_special_throttle | Integer | Indicates whether an excluded request throttling configuration has been created. The value can be:
|
| type | Integer | Type of the request throttling policy, which can be:
|
| bind_num | Integer | Number of APIs to which the request throttling policy has been bound |
| enable_adaptive_control | String | Enabling status of dynamic request throttling
This function is currently not available. |
{
"total": 2,
"size": 2,
"throttles": [{
"id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
"name": "500_calls_per_second",
"api_call_limits": 500,
"user_call_limits": 200,
"app_call_limits": 100,
"app_call_limits": 100,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T02:04:08Z",
"remark": "Total: 500 calls/second; user: 200 calls/second; app: 100 calls/second; IP address: 100 calls/second",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
},
{
"id": "0325b671-2d50-4614-9868-22102262695d",
"name": "1000_calls_per_second",
"api_call_limits": 1000,
"user_call_limits": 500,
"app_call_limits": 300,
"ip_call_limits": 600,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T01:55:59Z",
"remark": "Total: 1000 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
}]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Server Internal Error |
Last Article: Querying Details of a Request Throttling Policy
Next Article: Binding Request Throttling Policies
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.