API Gateway:CreateTrafficControl - API Gateway - Alibaba Cloud - API Gateway

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:CreateTrafficControl

create

*TrafficControl

acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/*

None

Request parameters

Parameter	Type	Required	Description	Example
TrafficControlName	string	Yes	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.	Throttling test
TrafficControlUnit	string	Yes	The unit to be used in the throttling policy. Valid values: SECOND MINUTE HOUR DAY	MINUTE
ApiDefault	integer	Yes	The default throttling value for each API.	10000
UserDefault	integer	No	The default throttling value for each user.	10000
AppDefault	integer	No	The default throttling value for each app.	10000
Description	string	No	The description of the throttling policy.	Throttling test description

Response elements

Element	Type	Description	Example
	object
TrafficControlId	string	The ID of the throttling policy.	tf123456
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.