Help Center> API Gateway> API Reference> Shared Gateway APIs (for Existing Users)> Excluded Request Throttling Configuration> Querying the List of Excluded Request Throttling Configurations
View PDF

Querying the List of Excluded Request Throttling Configurations

Function

This API is used to query all excluded configurations 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/throttle-specials/{strategy_id}[?page_size, page_no, instance_type, app_name, user]
  • A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
  • Query conditions include: strategy_id, app_name, user, page_size, and page_no.

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

strategy_id

Yes

String

Request throttling policy 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.

instance_type

No

String

Object type, which can be APP or USER

app_name

No

String

Name of an excluded app

user

No

String

Account ID

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

throttle_specials

Dictionary

Excluded request throttling configuration list

total

Integer

Number of excluded request throttling configurations that match the query conditions

size

Integer

Length of the returned excluded request throttling configuration list
Table 4 Parameter description of throttle_specials

Parameter

Type

Description

id

String

Excluded request throttling configuration ID

strategy_id

String

ID of the request throttling policy to which the excluded request throttling configuration belongs

instance_id

Integer

ID of an object specified in the excluded request throttling configuration

instance_name

String

Name of an app or a tenant to which the excluded request throttling configuration applies

instance_type

Integer

Type of the excluded object

call_limits

Integer

Maximum number of times the excluded object can access an API within the throttling period

apply_time

Timestamp

Time when the excluded request throttling configuration is created

app_id

String

ID of the app to which the excluded request throttling configuration applies

app_name

String

Name of the app to which the excluded request throttling configuration applies

Example response:

{
	"total": 1,
	"size": 1,
	"throttle_specials": [{
		"id": "778879b8-df10-495b-a087-874859fdea6d",
		"strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
		"instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
		"instance_name": "app_002",
		"instance_type": "APP",
		"call_limits": 180,
		"apply_time": "2017-12-29T03:11:18Z",
		"app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
		"app_name": "app_002"
	}]
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error