Querying APIs Bound with a Request Throttling Policy¶
Function¶
This API is used to query the APIs to which a specified request throttling policy has been bound.
URI¶
GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Gateway ID, which can be obtained from the gateway information on the APIG console. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
offset | No | Long | Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0 |
limit | No | Integer | Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20 |
throttle_id | Yes | String | Request throttling policy ID. |
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. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
size | Integer | Length of the returned resource list. |
total | Long | Number of resources that match the query conditions. |
apis | Array of ApiForThrottle objects | API list. |
Parameter | Type | Description |
---|---|---|
auth_type | String | API authentication mode. |
group_name | String | Name of the API group to which the API belongs. |
publish_id | String | API publication record ID. |
throttle_apply_id | String | ID of a request throttling policy binding record. |
apply_time | String | Binding time. |
remark | String | API description. |
run_env_id | String | ID of the environment in which the API has been published. |
type | Integer | API type. |
throttle_name | String | Name of the request throttling policy bound to the API. |
req_uri | String | Access address of the API. |
run_env_name | String | Name of the environment in which the API has been published. |
group_id | String | ID of the API group to which the API belongs. |
name | String | API name. |
id | String | API ID. |
req_method | String | Request method. Enumeration values:
|
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 403
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 404
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
None
Example Responses¶
Status code: 200
OK
{
"total" : 1,
"size" : 1,
"apis" : [ {
"run_env_name" : "RELEASE",
"group_name" : "api_group_001",
"publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a",
"name" : "Api_http",
"apply_time" : "2020-08-03T12:25:52Z",
"remark" : "Web backend API",
"run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"id" : "5f918d104dc84480a75166ba99efff21",
"type" : 1,
"throttle_name" : "throttle_demo",
"auth_type" : "APP",
"req_uri" : "/test/http"
} ]
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:throttle_id. Please refer to the support documentation"
}
Status code: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Status code: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Status code: 404
Not Found
{
"error_code" : "APIG.3005",
"error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.