DescribeApiTrafficControls API Throttling Policy Overview - API Gateway

Queries the throttling policies bound to all members of an API group in a specified environment.

Operation description

This API is intended for API providers.
The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.

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

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
StageName	string	Yes	The runtime environment of the API. Valid values: RELEASE TEST: the test environment	RELEASE
GroupId	string	Yes	The ID of the API group that you want to query.	0009db9c828549768a200320714b8930
ApiIds	string	No	The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.	123,234
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.	20

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	20
ApiTrafficControls	object
ApiTrafficControlItem	array<object>	The returned throttling policy information. It is an array consisting of ApiTrafficControlItem data.
	object
BoundTime	string	The binding time of the throttling policy.	2016-07-23T08:28:48Z
ApiId	string	The ID of the API.	46fbb52840d146f186e38e8e70fc8c90
TrafficControlId	string	The ID of the throttling policy.	dd05f1c54d6749eda95f9fa6d491449a
TrafficControlName	string	The name of the throttling policy.	backendsignature
ApiName	string	API operation	testapi

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiTrafficControls": {
    "ApiTrafficControlItem": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
        "TrafficControlId": "dd05f1c54d6749eda95f9fa6d491449a",
        "TrafficControlName": "backendsignature",
        "ApiName": "testapi"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.