Querying the List of APIs Bound to a Request Throttling Policy

Function

This API is used to query the list of APIs to which a specified request throttling policy has been bound.

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-apis[?page_size, page_no, throttle_id, env_id, group_id, api_id,api_name]

Note

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

The following table lists the parameters in the URI.

Table 2 Parameter description
Parameter	Mandatory	Type	Description
throttle_id	Yes	String	ID of a request throttling policy
env_id	No	String	Environment ID
group_id	No	String	API group ID
api_id	No	String	API ID
api_name	No	String	API name
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 APIs that match the query conditions
size	Integer	Length of the returned API list
apis	Dictionary	API list

Table 4 Parameter description of apis
Parameter	Type	Description
id	String	API ID
name	String	API name
group_id	String	ID of the API group to which the API belongs
group_name	String	Name of the API group to which the API belongs
type	Integer	API type
remark	String	Description of the API
run_env_name	String	Name of the environment in which the API has been published
run_env_id	String	ID of the environment in which the API has been published
publish_id	String	ID of the publication record
throttle_apply_id	String	Binding ID
throttle_name	String	Name of the request throttling policy bound to the API
apply_time	Timestamp	Time when the request throttling policy is bound to the API
auth_type	String	Security authentication mode
req_uri	String	Access address

Example response:

{
	"total": 2,
	"size": 2,
	"apis": [{
		"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
		"name": "API_group_list_query",
		"type": 1,
		"remark": "API group list query",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"group_name": "api_group_001",
		"run_env_name": "RELEASE",
		"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
		"publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057",
		"throttle_apply_id": "90f05978-06a3-4096-8bea-b5e2fa12b843",
		"throttle_name": "throttle1",
		"apply_time": "2017-12-29T03:01:11.138456Z",
		"auth_type": "APP",
		"req_uri": "/test"
	},
	{
		"id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"name": "API_list_query",
		"type": 1,
		"remark": "API list query",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"group_name": "api_group_001",
		"run_env_name": "RELEASE",
		"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
		"publish_id": "374a6d5a-20c7-4ea1-82e1-19fce4556956",
		"throttle_apply_id": "507c6a9f-8322-4dc2-8ba5-b4d74e3690d3",
		"throttle_name": "throttle1",
		"apply_time": "2017-12-29T03:01:11.138456Z",
		"auth_type": "APP",
		"req_uri": "/test"
	}]
}

Status Codes

Table 5 Status codes
Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Server Internal Error

Parent topic: Binding Request Throttling Policies

Предыдущая статья

Binding a Request Throttling Policy

Следующая статья

Querying the List of Request Throttling Policies Bound to an API

Была ли эта статья полезна?

Поддержка Юридические документы