跳到正文
Indiana
控制台
文档
章节目录 / 提交用量批次

提交用量批次

POST/api/v1/usage/batch

提交最多 1,000 项持久用量任务，HTTP 202 只表示已入队。保留整个批次输入和原 requestId，响应丢失时原样重试；修改内容会冲突。readUsageBatch 逐项读取 accepted／rejected／failed 和回执，批次不具有跨项目事务语义。

SDK 0.0.1更新于

发起请求

提交最多 1,000 项持久用量任务，HTTP 202 只表示已入队。保留整个批次输入和原 requestId，响应丢失时原样重试；修改内容会冲突。readUsageBatch 逐项读取 accepted／rejected／failed 和回执，批次不具有跨项目事务语义。

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

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

请求参数

JSON 请求体

requestIduuid必填

你的业务请求 UUID；同一次操作重试复用，新的操作生成新值。

itemsarray必填

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

minItems: 1 · maxItems: 1000

展开子字段
customerIduuid必填

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

commandobject必填

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

展开子字段
operation"consume"必填

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

overageBehaviorenum可选

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

查看允许值

"cap""overflow"

occurredAtdate-time可选

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

entitlementIduuid必填

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

entityIduuid可选

当前客户范围内的实体 ID；只用于已配置的实体和许可功能。

quantitystring必填

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

pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$

propertiesobject必填

服务端校验的计价属性，用于匹配维度和倍率。

idempotencyKeystring必填

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

minLength: 1 · maxLength: 120

响应字段

成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。

HTTP 202 · application/json

requestIduuid必填

服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。

scopeobject必填

响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。

展开子字段
projectIdstring必填

凭据绑定的 App ID。

minLength: 1

environmentenum必填

独立数据范围：sandbox 或 live。

查看允许值

"sandbox""live"

batchIduuid必填

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

处理错误

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

常见失败

  • UNAUTHENTICATED

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

  • FORBIDDEN

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

  • INVALID_REQUEST

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

  • SCOPE_MISMATCH

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

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