GetGatewayQuotaRule - 查询FinOps配额规则详情-API 网关(API Gateway)-阿里云帮助中心

查询网关配额限流规则详情。

接口说明

该接口用于查询 AI 网关上某条消费者配额规则。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetGatewayQuotaRule

get

*Gateway

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关 ID	gw-123456
ruleId	string	否	策略 ID	qr-d8j7fpmm1hks65xxxxx

请求参数

名称	类型	必填	描述	示例值
withSubjects	boolean	否	是否输出通用主体列表，对消费者和消费者组规则均生效。
withConsumers	boolean	否	是否输出消费者列表
consumerPageNumber `deprecated`	string	否	页数	1
consumerPageSize `deprecated`	string	否	页大小	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	1234567890
code	string	状态码	200
message	string	响应信息	success
data	object	响应数据	{"ruleId":1001}
ruleId	string	规则 ID	qr-d8j7fpmm1hks65xxxxxx
ruleName	string	规则名称	daily-token-limit
quotaDimension	string	配额维度	token
quotaLimit	integer	限制额度	1000
ruleStatus	string	规则状态枚举值： disabled : disabled enabled : enabled	enabled
periodType	string	配额周期类型	day
windowAlignment	string	重置周期类型	calendar
timezone	string	自然周期对应的时区(UTC+x 格式)	GMT+8
baseTimestamp	integer	周期基准时间戳	1745846400000
subjectType	string	规则主体类型，取值为 consumer 或 consumer_group。	consumer_group
subjectCount	integer	关联主体数量	120
subjects	array<object>	绑定在此规则上的通用主体列表；仅在 withSubjects=true 时返回。
	object	绑定在此规则上的主体
subjectType	string	主体类型，取值为 consumer 或 consumer_group。	consumer
id	string	主体 ID	cs-xxx
name	string	主体名称	consumer-a
consumerCount	integer	规则关联消费者数量	20
consumers	array<object>	绑定在此规则上的主体（消费者）列表
	object	绑定在此规则的主体（消费者）
id	string	主体（消费者）ID	c-aaa
name	string	主体（消费者）名称	consumer-a

示例

正常返回示例

JSON格式

{
  "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,
    "subjectType": "consumer_group",
    "subjectCount": 120,
    "subjects": [
      {
        "subjectType": "consumer",
        "id": "cs-xxx",
        "name": "consumer-a"
      }
    ],
    "consumerCount": 20,
    "consumers": [
      {
        "id": "c-aaa",
        "name": "consumer-a"
      }
    ]
  }
}

错误码

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

变更历史

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