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

Modifying an Excluded Request Throttling Configuration

Function

This API is used to modify an excluded configuration 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

PUT

/v1.0/apigw/throttle-specials/{id}

The following table lists the parameter in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

id

Yes

String

Excluded request throttling configuration ID

Request

Table 3 Parameter description

Parameter

Mandatory

Type

Description

call_limits

Yes

Integer

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

Example request:

{
	"call_limits": 180
}

Response

Table 4 Parameter description

Parameter

Type

Description

id

String

Excluded request throttling configuration ID

strategy_id

String

ID of the request throttling policy to which the excluded 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:

{
	"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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error