All Products
Search
Document Center

API Gateway:CreateTrafficControl

Last Updated:Mar 01, 2024

Creates a custom throttling policy.

Operation description

  • This API is intended for API providers.
  • Throttling policies must be bound to APIs to take effect. After a policy is bound to an API, it goes into effect on that API immediately.
  • The QPS limit on this operation is 50 per user.

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:CreateTrafficControlWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TrafficControlNamestringYes

The name of the throttling policy. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It cannot start with an underscore.

ThrottlingTest
TrafficControlUnitstringYes

The unit to be used in the throttling policy. Valid values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
MINUTE
ApiDefaultintegerYes

The default throttling value for each API.

10000
UserDefaultintegerNo

The default throttling value for each user.

10000
AppDefaultintegerNo

The default throttling value for each app.

10000
DescriptionstringNo

The description of the throttling policy.

ThrottlingTestDescription

Response parameters

ParameterTypeDescriptionExample
object
TrafficControlIdstring

The ID of the throttling policy.

tf123456
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Sample success responses

JSONformat

{
  "TrafficControlId": "tf123456",
  "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