Updated on 2022-09-01 GMT+08:00

Querying Details of a Request Throttling Policy

Function

This API is used to query the details of a request throttling policy.

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/throttles/{id}

The following table lists the parameter in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

id

Yes

String

ID of a request throttling policy

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

id

String

ID of the 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:
  • 1: yes
  • 2: no

type

Integer

Type of the request throttling policy, which can be:

  • 1: exclusive
  • 2: shared

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

  • TRUE
  • FALSE

This function is currently not available.

Example response:
{
	"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": 0,
        "enable_adaptive_control": "FALSE"
}

Status Codes

Table 4 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error