管理用量归属对象

POST/api/v1/usage/entities

为客户创建或归档用量归属对象，例如工作区；可信后端指定客户，余额操作可引用返回的对象 ID。

SDK 0.0.1更新于 2026年10月14日

发起请求

为客户创建或归档用量归属对象，例如工作区；可信后端指定客户，余额操作可引用返回的对象 ID。

调用凭据: 仅服务端 API Key。由可信后端调用。
所需权限: credits:manage

base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。

request.shShell

1curl -X POST "$GROOVE_BASE_URL/api/v1/usage/entities" \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  "command": {9    "action": "upsert",10    "externalId": "workspace_123",11    "name": "Design workspace"12  }13}'

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

请求参数

JSON 请求体

customerIduuid必填

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

commandobject | object必填

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

展开子字段

action"upsert" | "archive"必填

本次业务动作。不同动作的目标字段和数量要求不同，见请求结构与示例。

externalIdstring可选

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

minLength: 1 · maxLength: 128

namestring可选

客户或对象的展示名称，不作为身份唯一键。

minLength: 1 · maxLength: 80

entityIduuid可选

当前客户范围内的实体 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"

entityobject必填

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

展开子字段

iduuid必填

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

externalIdstring必填

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

minLength: 1 · maxLength: 128

namestring必填

客户或对象的展示名称，不作为身份唯一键。

minLength: 1 · maxLength: 80

archivedboolean必填

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

处理错误

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

常见失败

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

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