All Products
Search
Document Center

API Gateway:AddTrafficSpecialControl

Last Updated:Mar 01, 2024

Adds a custom special policy to a specified throttling policy.

Operation description

  • This API is intended for API providers.
  • If the input SpecialKey already exists, the previous configuration is overwritten. Use caution when calling this operation.
  • Special throttling policies must be added to an existing throttling policy, and can take effect on all the APIs to which the throttling policy is bound.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:AddTrafficSpecialControlWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TrafficControlIdstringYes

The ID of the specified throttling policy.

tf123456
SpecialTypestringYes

The type of the special throttling policy. Valid values:

  • APP
  • USER
APP
SpecialKeystringYes

The ID of the app or Alibaba Cloud account. Specify this parameter based on the value of the SpecialType parameter. You can view your account ID on the Account Management page.

3382463
TrafficValueintegerYes

The special throttling value.

10000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history