Querying the List of Request Throttling Policies Bound to an API

Function

This API is used to query the list of request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

**Table 1** HTTP/HTTPS request method and URI
Request Method	URI
GET	/v1.0/apigw/throttle-bindings/binded-throttles[?page_no, page_size, api_id, throttle_id, throttle_name,env_id]

A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
Query conditions include: api_id, throttle_id, throttle_name, env_id, page_size, and page_no.

The following table lists the parameters in the URI.

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
api_id	Yes	String	API ID
throttle_id	No	String	Request throttling policy ID
throttle_name	No	String	Request throttling policy name
env_id	No	String	Environment ID
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.

Request

N/A

Response

**Table 3** Parameter description
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

**Table 4** Parameter description of throttles
Parameter	Type	Description
id	String	Request throttling policy ID
name	String	Request throttling policy name
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: 1: yes 2: no
env_name	String	Environment in which the request throttling policy takes effect
type	Integer	Type of the request throttling policy
bind_id	String	Binding ID
bind_time	Timestamp	Time when the request throttling policy is bound to the API
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.

Example response:

{
	"total": 1,
	"size": 1,
	"throttles": [{
		"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": 100,
		"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",
		"is_inclu_special_throttle": 2,
		"env_name": "RELEASE",
                "type":1,
                "bind_id":"359f5c1868f647b6ad0f0d285154a791",
                "bind_time":"2019-07-08T01:27:38Z",
                "bind_num":1,
                "enable_adaptive_control":"FALSE"
	}]
}