读取独立余额授予
POST/api/v1/balances/grants/list
按客户分页读取规则与当前可用、冻结、已消费数量，包含 Entity 专属额度。
SDK 0.0.1更新于
发起请求
按客户分页读取规则与当前可用、冻结、已消费数量，包含 Entity 专属额度。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/balances/grants/list" \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 "after": null,9 "limit": 5010}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
afteruuid | null必填本次操作的 after 值，类型和约束见字段标注。
limitinteger必填一页返回的最大记录数量，受契约上限限制。
min: 1 · max: 100
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
grantsobject必填本次操作的 grants 值，类型和约束见字段标注。
展开子字段
rowsarray必填本次操作的 rows 值，类型和约束见字段标注。
maxItems: 100
展开子字段
iduuid必填本次操作的 id 值，类型和约束见字段标注。
entitlementVersionIduuid必填本次操作的 entitlementVersionId 值，类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
namestring必填客户或对象的展示名称，不作为身份唯一键。
amountobject | null必填积分或账本金额，按字段的十进制字符串或整数类型传入。
resetobject | null必填本次操作的 reset 值，类型和约束见字段标注。
展开子字段
intervalenum必填本次操作的 interval 值，类型和约束见字段标注。
查看允许值
"minute""hour""day""week""month""quarter""semi_annual""year"
countinteger必填本次操作的 count 值，类型和约束见字段标注。
min: 1 · max: 1000
rolloverobject | null必填本次操作的 rollover 值，类型和约束见字段标注。
展开子字段
capobject | null必填本次操作的 cap 值，类型和约束见字段标注。
capPercentagenumber | null必填本次操作的 capPercentage 值，类型和约束见字段标注。
cyclesinteger | null必填本次操作的 cycles 值，类型和约束见字段标注。
nextResetAtdate-time | null必填本次操作的 nextResetAt 值，类型和约束见字段标注。
startsAtdate-time必填本次操作的 startsAt 值，类型和约束见字段标注。
expiresAtdate-time | null必填ISO 8601 UTC 到期时间；会话和预占到期后不能继续使用。
revisioninteger必填读取资料时返回的版本号；更新使用它检测并发修改。
min: 0 · max: 9007199254740991
revokedboolean必填本次操作的 revoked 值，类型和约束见字段标注。
availablestring必填本次操作的 available 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
heldstring必填本次操作的 held 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
spentstring必填本次操作的 spent 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
nextCursoruuid | null必填下一页游标；null 表示结束。原样传回，改筛选条件时清空。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引