ListConsumerQuotaRules - 查询消费者上已配置的配额规则列表-API 网关(API Gateway)-阿里云帮助中心

查询某个消费者上已配置的配额规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListConsumerQuotaRules

none

*Domain

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
consumerId	string	否	消费者 ID	cs-d8kkaium1hks607xxxxx

请求参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关 ID，可选	gw-123456
keyword	string	否	规则名称关键词，用于模糊匹配	daily
pageNumber	integer	否	页码	1
pageSize	integer	否	每页数量	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	1234567890
code	string	状态码	200
message	string	响应信息	success
data	object	响应数据	{"totalSize":100}
totalSize	integer	配置的配额规则总条数	100
pageNumber	integer	当前页码	1
pageSize	integer	当前页大小	10
items	array<object>	规则列表	[{"ruleId":"rule-001"}]
	object	规则条目	{'ruleId':'rule-001','ruleName':'daily-token-limit'}
ruleId	string	规则 ID	qr-d8j7fpmm1hksxxxxxx
ruleName	string	规则名称	daily-token-limit
gatewayId	string	规则所属的网关 ID	gw-123456
gatewayName	string	规则所属的网关名称	prod-gateway
quotaDimension	string	配额维度	token
quotaLimit	integer	限制额度	1000
windowAlignment	string	周期类型。calendar 代表自然周期；epoch 代表自定义周期。	calendar
ruleStatus	string	规则状态枚举值： disabled : disabled enbaled : enbaled	enabled
periodType	string	周期类型	week
periodMultiplier	string	周期倍数，代表每多少个周期进行配额重置。当规则为自定义周期时返回，最小为 1，最大为 60。	30
timezone	string	自然周期对应的时区(UTC+x 格式)	UTC+8

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。