ListGatewayQuotaRules-阿里云帮助中心

Operation description

Queries API consumer quota rules bound to a 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:ListGatewayQuotaRules

list

*Gateway

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The gateway ID.	gw-123456

Request parameters

Parameter	Type	Required	Description	Example
keyword	string	No	The keyword for fuzzy matching by rule name.	daily
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries per page.	10
maxResults	integer	No	The maximum number of records to retrieve in a single request. This parameter is not supported.	20
nextToken	string	No	The pagination token. This parameter is not supported.	C4tM8BlBJwHSNyjWpGaci4/7dKNGp1JMgsKtvCagmtY=

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	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 entries.	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	The rule ID.	qr-xxxxx
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.	enabled
periodType	string	The period type.	week
timezone	string	The time zone for the calendar period, in UTC+x format.	GMT+8
windowAlignment	string	The reset period type. Only calendar periods are supported, meaning windowAlignment is always set to calendar.	calendar
maxResults	integer	The maximum number of records to retrieve in a single request. This parameter is not supported.	100
nextToken	string	The pagination token. This parameter is not supported.	762b1fa4e2434fd3959b1f66481979cf

Examples

Success response

JSON format

{
  "requestId": "1234567890",
  "code": "200",
  "message": "success",
  "data": {
    "totalSize": 100,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "ruleId": "qr-xxxxx",
        "ruleName": "daily-token-limit",
        "quotaDimension": "token",
        "quotaLimit": 1000,
        "ruleStatus": "enabled",
        "periodType": "week",
        "timezone": "GMT+8",
        "windowAlignment": "calendar"
      }
    ]
  },
  "maxResults": 100,
  "nextToken": "762b1fa4e2434fd3959b1f66481979cf"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.