Query Custom Throttling Policies via DescribeTrafficControls - API Gateway

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.

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:DescribeTrafficControls

get

*TrafficControl

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

None

Request parameters

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 TEST**	RELEASE
TrafficControlName	string	No	The name of the throttling policy.	Throttling test
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 elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	93D91A99-F093-4596-87BA-3C4FBFD3FD8A
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	1
TrafficControls	object
TrafficControl	array<object>	The returned throttling policy information. It is an array consisting of TrafficControl data.
	array<object>
UserDefault	integer	The default throttling value for each user.	15000
ApiDefault	integer	The default throttling value for each API.	20000
ModifiedTime	string	The last modification time (UTC) of the throttling policy.	2016-01-27T10:34:38Z
Description	string	The description of the throttling policy.	test
TrafficControlUnit	string	The unit to be used in the throttling policy. Valid values: MINUTE HOUR DAY	Minute
TrafficControlName	string	The name of the throttling policy.	wulingtestq1
AppDefault	integer	The default throttling value for each app.	8000
TrafficControlId	string	The ID of the throttling policy.	cfed6c970d45481dbe136d6b5ac68c41
CreatedTime	string	The creation time (UTC) of the throttling policy.	2016-01-27T10:19:39Z
SpecialPolicies	object
SpecialPolicy	array<object>	The returned information about a special throttling policy. It is an array consisting of SpecialPolicy data.
	array<object>
SpecialType	string	The type of the special throttling policy. Valid values: APP USER	USER
Specials	object
Special	array<object>	The returned information about a special throttling policy. It is an array consisting of Special data.
	object
TrafficValue	integer	The throttling value.	100
SpecialKey	string	The AppId or user account corresponding to SpecialType.	test_wg@aliyun.com

Examples

Success response

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.