读取当前用量
POST/api/v1/usage/read
读取非消耗型功能的实际占用、可用容量与版本；容量变更不改写已同步的实际状态。
SDK 0.0.1更新于
发起请求
读取非消耗型功能的实际占用、可用容量与版本；容量变更不改写已同步的实际状态。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/usage/read" \2 -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "customerId": "00000000-0000-4000-8000-000000000001",8 "query": {9 "entitlementId": "00000000-0000-4000-8000-000000000001",10 "entityId": null11 }12}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
queryobject必填本次操作的 query 值，类型和约束见字段标注。
展开子字段
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
usageobject必填本次操作的 usage 值，类型和约束见字段标注。
展开子字段
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
operationIduuid | null必填业务操作 UUID；订阅执行引用 previewAttach 返回的 operationId，余额退款引用原消费操作。
usageobject必填本次操作的 usage 值，类型和约束见字段标注。
capacitystring | null必填本次操作的 capacity 值，类型和约束见字段标注。
remainingstring | null必填评估时的剩余额度，不预占，也不保证稍后消费成功。
withinLimitboolean必填本次操作的 withinLimit 值，类型和约束见字段标注。
revisioninteger必填读取资料时返回的版本号；更新使用它检测并发修改。
min: 0 · max: 9007199254740991
updatedAtdate-time | null必填记录最后更新时的 ISO 8601 UTC 时间。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引