DescribeRateLimitPolicy

Queries rate limit policies.

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

polardb:DescribeRateLimitPolicy

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
GwClusterId	string	Yes	The ID of the gateway instance.	pg-xxxxxxx
PolicyId	string	No	The ID of the rate limit policy.	02eccf7c61cf4d05a543075ee907f3**
ScopeType	string	No	The scope of the rate limit policy. Valid values: ConsumerGroup: The policy applies to a consumer group. Consumer: The policy applies to a specific consumer.	ConsumerGroup
ScopeRefId	string	No	The ID of the target resource, which can be a consumer group or a consumer, depending on the `ScopeType` value.	cg-xxxxxxxx
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100. The default value is 30.	30
PageNumber	integer	No	The page number to return. The default value is 1.	1

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	CED079B7-A408-41A1-BFF1-EC608E******
TotalRecordCount	string	The total number of matching entries.	1
PageSize	string	The number of entries returned per page.	30
PageNumber	string	The returned page number.	1
PageRecordCount	string	The number of entries returned on the current page.	30
Items	array<object>	An array of rate limit policy objects.
	object	A rate limit policy object.
PolicyId	string	The ID of the rate limit policy.	02eccf7c61cf4d05a543075ee907f3**
GwClusterId	string	The ID of the gateway instance.	pg-xxxxxxxx
PolicyType	string	The policy type.	RateLimit
ScopeType	string	The scope of the policy. Valid values: ConsumerGroup: The policy applies to a consumer group. Consumer: The policy applies to a specific consumer.	ConsumerGroup
ScopeRefId	string	The ID of the object within the policy's scope, such as a consumer group or a consumer.	cg-xxxxxxx
RateLimitRpm	string	The maximum requests per minute (RPM).	10
RateLimitTpm	string	The maximum tokens per minute (TPM).	10
Status	string	The status of the policy. Valid values: Enabled: The policy is enabled. Disabled: The policy is disabled.	Enabled
GmtCreated	string	The creation time.	2025-12-01T17:52:05+08:00
GmtModified	string	The modification time.	2026-01-19T16:47:25+08:00

Examples

Success response

JSON format

{
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "TotalRecordCount": "1",
  "PageSize": "30",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "Items": [
    {
      "PolicyId": "02eccf7c61cf4d05a543075ee907f3**\n",
      "GwClusterId": "pg-xxxxxxxx",
      "PolicyType": "RateLimit",
      "ScopeType": "ConsumerGroup ",
      "ScopeRefId": "cg-xxxxxxx",
      "RateLimitRpm": "10",
      "RateLimitTpm": "10",
      "Status": "Enabled",
      "GmtCreated": "2025-12-01T17:52:05+08:00",
      "GmtModified": "2026-01-19T16:47:25+08:00"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.