Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Dedicated - Request Throttling Policy Management/ Deleting Request Throttling Policies
Updated on 2026-05-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Request Throttling Policies

Function

This API is used to delete request throttling policies.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    apig:requestThrottling:batchDelete

    Write

    instance *

    g:ResourceTag/<tag-key>

    apig:throttles:delete

    apig:instance:get

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/batch-delete

Table 1 Path Parameters

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.

Request Parameters

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

throttles

No

Array of strings

IDs of the request throttling policies to delete.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success_count

Integer

Number of request throttling policies that have been successfully deleted.

failure

ThrottleBatchFailure object

Response of a batch operation failure.
Table 5 ThrottleBatchFailure

Parameter

Type

Description

throttle_id

String

ID of the request throttling policy that fails the operation.

throttle_name

String

Name of the request throttling policy that fails the operation.

error_code

String

Error code.

error_msg

String

Error message.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Delete request throttling policies.

{
  "throttles" : [ "3437448ad06f4e0c91a224183116e965" ]
}

Example Responses

Status code: 200

OK

{
  "success_count" : 1
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameter action should be \\\"delete\\\""
}

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.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

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.