Queries custom throttling policies and their details. Conditional queries are supported.
Operation description
- This API is intended for API providers.
- This API can be used to query all existing throttling policies (including special throttling policies) and their details.
- You can specify query conditions. For example, you can query the throttling policies bound to a specified API or in a specified environment.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
apigateway:DescribeTrafficControls | get | *TrafficControl acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TrafficControlId | string | No | The ID of the throttling policy. | tf123456 |
GroupId | string | No | The specified group ID. This parameter must be specified together with ApiId and StageName. | 0009db9c828549768a200320714b8930 |
ApiId | string | No | The specified API ID. This parameter must be specified together with GroupId and StageName. | 3b81fd160f5645e097cc8855d75a1cf6 |
StageName | string | No | The environment name. This parameter must be specified together with GroupId and ApiId. Valid values:********
| RELEASE |
TrafficControlName | string | No | The name of the throttling policy. | ThrottlingTest |
PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Maximum value: 100. Default value: 10. | 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"PageNumber": 1,
"RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
"PageSize": 10,
"TotalCount": 1,
"TrafficControls": {
"TrafficControl": [
{
"UserDefault": 15000,
"ApiDefault": 20000,
"ModifiedTime": "2016-01-27T10:34:38Z",
"Description": "test",
"TrafficControlUnit": "Minute",
"TrafficControlName": "wulingtestq1",
"AppDefault": 8000,
"TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
"CreatedTime": "2016-01-27T10:19:39Z",
"SpecialPolicies": {
"SpecialPolicy": [
{
"SpecialType": "USER",
"Specials": {
"Special": [
{
"TrafficValue": 100,
"SpecialKey": "test_wg@aliyun.com"
}
]
}
}
]
}
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
Change time | Summary of changes | Operation |
---|---|---|
2024-11-14 | API Description Update | View Change Details |