GetGatewayQuotaRule-阿里云帮助中心

Operation description

Queries a specific consumer quota rule on an AI gateway.

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

apig:GetGatewayQuotaRule

get

*Gateway

acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

None

Request syntax

GET /v1/gateways/{gatewayId}/quota-rules/{ruleId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The gateway ID.	gw-123456
ruleId	string	No	The policy ID.	qr-d8j7fpmm1hks65xxxxx

Request parameters

Parameter	Type	Required	Description	Example
withConsumers	boolean	No	Whether to return the consumer list.
consumerPageNumber `deprecated`	string	No	The page number of the consumer list.	1
consumerPageSize `deprecated`	string	No	The page size of the consumer list.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	1234567890
code	string	The status code.	200
message	string	The response message.	success
data	object	The response data.	{"ruleId":1001}
ruleId	string	The rule ID.	qr-d8j7fpmm1hks65xxxxxx
ruleName	string	The rule name.	daily-token-limit
quotaDimension	string	The quota dimension.	token
quotaLimit	integer	The quota limit.	1000
ruleStatus	string	The rule status. Valid values: disabled : disabled enabled : enabled	enabled
periodType	string	The quota period type.	day
windowAlignment	string	The reset period type. Currently, only the calendar period is supported, meaning windowAlignment="calendar".	calendar
timezone	string	The time zone corresponding to the calendar period, in UTC+x format.	GMT+8
baseTimestamp	integer	The base timestamp of the period.	1745846400000
consumerCount	integer	The number of consumers associated with the rule.	20
consumers	array<object>	The list of principals (consumers) bound to this rule.
	object	The principal (consumer) bound to this rule.
id	string		c-aaa
name	string		consumer-a

Examples

Success response

JSON format

{
  "requestId": "1234567890",
  "code": "200",
  "message": "success",
  "data": {
    "ruleId": "qr-d8j7fpmm1hks65xxxxxx",
    "ruleName": "daily-token-limit",
    "quotaDimension": "token",
    "quotaLimit": 1000,
    "ruleStatus": "enabled",
    "periodType": "day",
    "windowAlignment": "calendar",
    "timezone": "GMT+8",
    "baseTimestamp": 1745846400000,
    "consumerCount": 20,
    "consumers": [
      {
        "id": "c-aaa",
        "name": "consumer-a"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.