跳到正文
Indiana
控制台
文档
章节目录 / 读取批次进度

读取批次进度

POST/api/v1/usage/batch/read

分页读取批次的处理结果。

SDK 0.0.1更新于

发起请求

分页读取批次的处理结果。

调用凭据
仅服务端 API Key。由可信后端调用。
所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值,不会执行请求。服务端 Key 不可放入浏览器。
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/usage/batch/read" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "batchId": "00000000-0000-4000-8000-000000000001",  "after": -1,  "limit": 50}'

响应选项卡列出字段类型,不是响应示例;实际值由客户状态决定。

请求参数

JSON 请求体

batchIduuid必填

本次操作的 batchId 值,类型和约束见字段标注。

afterinteger必填

本次操作的 after 值,类型和约束见字段标注。

min: -1 · max: 999

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"

batchobject必填

本次操作的 batch 值,类型和约束见字段标注。

展开子字段
batchIduuid必填

本次操作的 batchId 值,类型和约束见字段标注。

statusenum必填

本次操作的 status 值,类型和约束见字段标注。

查看允许值

"queued""complete"

totalinteger必填

本次操作的 total 值,类型和约束见字段标注。

min: 1 · max: 1000

processedinteger必填

本次操作的 processed 值,类型和约束见字段标注。

min: 0 · max: 1000

itemsarray必填

本次操作的 items 值,类型和约束见字段标注。

maxItems: 100

展开子字段
positioninteger必填

本次操作的 position 值,类型和约束见字段标注。

min: 0 · max: 999

customerIduuid必填

Indiana 客户 ID。服务端从已验证身份关联;客户 Token 调用时省略并使用 Token 绑定的客户。

idempotencyKeystring必填

稳定的业务幂等 Key。同一 Key 和同一参数返回同一结果;不要每次重试随机生成。

minLength: 1 · maxLength: 120

statusenum必填

本次操作的 status 值,类型和约束见字段标注。

查看允许值

"queued""accepted""rejected""failed"

receiptobject | null必填

本次操作的 receipt 值,类型和约束见字段标注。

展开子字段
iduuid必填

本次操作的 id 值,类型和约束见字段标注。

entitlementIduuid必填

本次操作的 entitlementId 值,类型和约束见字段标注。

kindenum必填

本次操作的 kind 值,类型和约束见字段标注。

查看允许值

"consume""reserve""confirm""refund""release""expire"

originalIduuid | null必填

本次操作的 originalId 值,类型和约束见字段标注。

quantityobject必填

业务数量按字段标注类型传入;积分操作用十进制字符串,避免浮点误差。quote/reserve/confirm/refund 要求正数;consume 可记录零费用事件。

requestedQuantityobject可选

显式 cap/overflow 的原请求数量;quantity 是实际接受或拒绝的数量。

overageBehaviorenum可选

cap 接受当前许可及上限内的最大数量,可为 0;overflow 请求完整数量并检查超额许可、用量上限和现金预算。省略时维持整次不足就拒绝。

查看允许值

"cap""overflow"

acceptedboolean必填

操作是否被业务规则接受。HTTP 200 不等于 accepted 为 true。

reasonenum | null必填

拒绝原因或账本操作说明;结合 accepted / 状态判断结果。

createdAtdate-time必填

记录创建时的 ISO 8601 UTC 时间。

reservationStatusenum | null必填

本次操作的 reservationStatus 值,类型和约束见字段标注。

expiresAtdate-time | null必填

ISO 8601 UTC 到期时间;会话和预占到期后不能继续使用。

allocationsarray必填

本次规则计算或账本操作涉及的余额分配明细。

maxItems: 500

errorCodeenum | null必填

本次操作的 errorCode 值,类型和约束见字段标注。

nextAfterinteger | null必填

本次操作的 nextAfter 值,类型和约束见字段标注。

处理错误

常见失败
错误码处理方式
UNAUTHENTICATED核对 Key,或将过期客户 Token 重新签发一次。
FORBIDDEN核对当前 Key 权限与客户访问范围。
INVALID_REQUEST检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH使用凭据绑定的 App 和环境。

常见失败

  • UNAUTHENTICATED

    处理方式
    核对 Key,或将过期客户 Token 重新签发一次。
  • FORBIDDEN

    处理方式
    核对当前 Key 权限与客户访问范围。
  • INVALID_REQUEST

    处理方式
    检查字段类型、UUID、十进制字符串和互斥字段。
  • SCOPE_MISMATCH

    处理方式
    使用凭据绑定的 App 和环境。

相关:完整请求与错误约定·返回接口索引