ListConsumerQuotaRules - API Gateway - Alibaba Cloud Documentation Center

Queries the list of quota rules configured for a specific consumer.

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

none

*Domain

acs:apig:{#regionId}:{#accountId}:consumer/{#ConsumerId}

None

Request syntax

GET /v1/consumers/{consumerId}/quota-rules HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
consumerId	string	No	The consumer ID.	cs-d8kkaium1hks607xxxxx

Request parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The gateway ID. This parameter is optional.	gw-123456
keyword	string	No	The rule name keyword, used for fuzzy match.	daily
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	1234567890
code	string	The status code.	200
message	string	The response message.	success
data	object	The response data.	{"totalSize":100}
totalSize	integer	The total number of configured quota rules.	100
pageNumber	integer	The current page number.	1
pageSize	integer	The current page size.	10
items	array<object>	The list of rules.	[{"ruleId":"rule-001"}]
	object	The rule entry.	{'ruleId':'rule-001','ruleName':'daily-token-limit'}
ruleId	string		qr-d8j7fpmm1hksxxxxxx
ruleName	string		daily-token-limit
gatewayId	string		gw-123456
gatewayName	string		prod-gateway
quotaDimension	string		token
quotaLimit	integer		1000
windowAlignment	string		calendar
ruleStatus	string	Valid values: disabled : disabled enbaled : enbaled	enabled
periodType	string		week
periodMultiplier	string		30
timezone	string		UTC+8

Examples

Success response

JSON format

{
  "requestId": "1234567890",
  "code": "200",
  "message": "success",
  "data": {
    "totalSize": 100,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "ruleId": "qr-d8j7fpmm1hksxxxxxx",
        "ruleName": "daily-token-limit",
        "gatewayId": "gw-123456",
        "gatewayName": "prod-gateway",
        "quotaDimension": "token",
        "quotaLimit": 1000,
        "windowAlignment": "calendar",
        "ruleStatus": "enabled",
        "periodType": "week",
        "periodMultiplier": "30",
        "timezone": "UTC+8"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.