GetGatewayQuotaRuleSubjectUsage - 获取配额规则下某个消费主体用量详情-API 网关(API Gateway)-阿里云帮助中心

查询网关配额限流规则主体用量详情，包括已用配额、总配额、是否超限、用量详情及消费记录等。

接口说明

该接口用于获取配额规则下的某个消费主体用量详情。注意，只针对于版本大于 2.1.19 的 AI 网关生效。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetGatewayQuotaRuleSubjectUsage

none

*Gateway

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关 ID	gw-123456
ruleId	string	否	规则 ID	qr-d8j7fpmm1hks65kxxxxx
subjectId	string	否	主体（消费者或消费者组）ID	cs-d8kkaium1xxxxxxxxxxx

请求参数

名称	类型	必填	描述	示例值
pageNumber	integer	否	对应消费主体在周期内详细消费（请求）记录的页码	1
pageSize	integer	否	对应消费主体在周期内详细消费（请求）记录的每页数量（最大限制为 10）	10
filterFailedRequests	boolean	否	是否过滤零值	true
startTime	integer	否	消费记录明细查询的开始时间，使用 Unix 时间戳，单位为秒。仅传入该参数时，系统按照规则周期自动计算 endTime。	1788338820
endTime	integer	否	消费记录明细查询的结束时间，使用 Unix 时间戳，单位为秒。仅传入该参数时，系统按照规则周期自动计算 startTime。	1788425220

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码	200
data	object	响应数据	{"usedAmount":500}
cachedAmount	integer	缓存 token 总消耗	20
cachedAmountDecimal	number	缓存总消耗精确值，credit 场景支持小数	20.5
details	object	消费明细分页	{"totalSize":100}
items	array<object>	用量明细列表	[{"model":"qwen-plus",'usedAmount':210}]
	object	消费明细条目	{'model':'qwen-plus','usedAmount':210}
cachedAmount	integer	缓存 token 消耗	10
cachedAmountDecimal	number	缓存消耗精确值，credit 场景支持小数	10.5
consumer	string	消费者名称	consumer-a
inputAmount	integer	输入 token 消耗	120
inputAmountDecimal	number	输入消耗精确值，credit 场景支持小数	120.5
model	string	模型名称	qwen-plus
outputAmount	integer	输出 token 消耗	80
outputAmountDecimal	number	输出消耗精确值，credit 场景支持小数	80.5
requestId	string	请求 ID	req-123456
startTime	string	消费（请求）时间（YYYY-MM-DD）	2026-06-05
usedAmount	integer	总消耗	210
usedAmountDecimal	number	总消耗精确值，credit 场景支持小数	210.5
pageNumber	integer	当前页码	1
pageSize	integer	当前页大小	10
totalSize	integer	总条数	100
inputAmount	integer	输入 token 总消耗	300
inputAmountDecimal	number	输入总消耗精确值，credit 场景支持小数	300.5
outputAmount	integer	输出 token 总消耗	180
outputAmountDecimal	number	输出总消耗精确值，credit 场景支持小数	180.5
overLimit	boolean	是否超限	false
quotaDimension	string	配额维度，取值为 token 或 credit。	token
subjectType	string	主体类型，取值为 consumer 或 consumer_group。	consumer_group
totalQuota	integer	主体总配额	1000
usedAmount	integer	主体已用总额度	500
usedAmountDecimal	number	主体已用总额度精确值，credit 场景支持小数	500.5
message	string	响应信息	success
requestId	string	Id of the request	1234567890

示例

正常返回示例

JSON格式

{
  "code": "200",
  "data": {
    "cachedAmount": 20,
    "cachedAmountDecimal": 20.5,
    "details": {
      "items": [
        {
          "cachedAmount": 10,
          "cachedAmountDecimal": 10.5,
          "consumer": "consumer-a",
          "inputAmount": 120,
          "inputAmountDecimal": 120.5,
          "model": "qwen-plus",
          "outputAmount": 80,
          "outputAmountDecimal": 80.5,
          "requestId": "req-123456",
          "startTime": "2026-06-05",
          "usedAmount": 210,
          "usedAmountDecimal": 210.5
        }
      ],
      "pageNumber": 1,
      "pageSize": 10,
      "totalSize": 100
    },
    "inputAmount": 300,
    "inputAmountDecimal": 300.5,
    "outputAmount": 180,
    "outputAmountDecimal": 180.5,
    "overLimit": false,
    "quotaDimension": "token",
    "subjectType": "consumer_group",
    "totalQuota": 1000,
    "usedAmount": 500,
    "usedAmountDecimal": 500.5
  },
  "message": "success",
  "requestId": "1234567890"
}

错误码

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

变更历史

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