Querying Request Throttling Policies Bound to an API
Function
This API is used to query the 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
GET /v2/{project_id}/apic/instances/{instance_id}/throttle-bindings/binded-throttles
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. |
instance_id |
Yes |
String |
Instance ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Long |
Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0. Default: 0 |
limit |
No |
Integer |
Number of items displayed on each page. Minimum: 1 Maximum: 500 Default: 20 |
api_id |
Yes |
String |
API ID. |
throttle_id |
No |
String |
ID of a request throttling policy. |
throttle_name |
No |
String |
Request throttling policy name. |
env_id |
No |
String |
Environment ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
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. |
throttles |
Array of ThrottleForApi objects |
Request throttling policy list. |
Parameter |
Type |
Description |
---|---|---|
app_call_limits |
Integer |
Maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than that of user_call_limits. The maximum value is 2,147,483,647. The value is a positive integer. |
name |
String |
Request throttling policy name. The value contains 3 to 64 characters, including letters, digits, and underscores (_). It must start with a letter.
NOTE:
Characters must be in UTF-8 or Unicode format. |
time_unit |
String |
Time unit for limiting the number of API calls. |
remark |
String |
Description of the request throttling policy, which can contain a maximum of 255 characters.
NOTE:
Characters must be encoded using UTF-8 or Unicode. |
api_call_limits |
Integer |
Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. The value is a positive integer. |
type |
Integer |
Type of the request throttling policy.
|
enable_adaptive_control |
String |
Whether to enable dynamic request throttling.
This parameter is currently not supported. |
user_call_limits |
Integer |
Maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer. |
time_interval |
Integer |
Period of time for limiting the number of API calls. This parameter applies with each of the preceding three API call limits. The maximum value is 2,147,483,647. The value is a positive integer. |
ip_call_limits |
Integer |
Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer. |
id |
String |
Request throttling policy ID. |
bind_num |
Integer |
Number of APIs to which the request throttling policy has been bound. |
is_inclu_special_throttle |
Integer |
Whether an excluded request throttling configuration has been created.
|
create_time |
String |
Creation time. |
env_name |
String |
Environment in which the request throttling policy takes effect. |
bind_id |
String |
Binding record ID. |
bind_time |
String |
Time when the request throttling policy is bound to the API. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "total" : 1, "size" : 1, "throttles" : [ { "id" : "3437448ad06f4e0c91a224183116e965", "name" : "throttle_demo", "api_call_limits" : 800, "user_call_limits" : 500, "app_call_limits" : 300, "ip_call_limits" : 600, "time_interval" : 1, "time_unit" : "SECOND", "create_time" : "2020-07-31T08:44:02Z", "remark" : "Throttling Policy 1", "is_inclu_special_throttle" : 2, "env_name" : "RELEASE", "type" : 1, "bind_id" : "3e06ac135e18477e918060d3c59d6f6a", "bind_time" : "2020-08-03T12:25:52Z", "bind_num" : 0, "enable_adaptive_control" : "FALSE" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:throttle_name. 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot