跳转到主要内容

文档说明

本文说明如何按成员或组织维度查询 Credits 用量事件与汇总,以及如何查询组织的共享资源包、席位·月余额批次明细与指定周期席位·月消耗(仅三方渠道购买组织适用)。调用前请完成 获取 API Key,并阅读 约定与规范

权限要求

  • 使用有效的 API Key。
  • API Key 须关联到目标组织。

概述

用量查询 API 提供成员级别的 Credits 用量明细和汇总查询,支持按日期、来源、操作和模型等级过滤;同时提供组织维度的共享资源包、席位·月余额批次与指定周期席位·月消耗查询,支持按状态、周期过滤和分页。

主要功能

  • 用量事件列表: 分页查询成员的聚合 Credits 用量记录
  • 用量汇总: 按维度(来源或操作)汇总成员在指定时间范围内的 Credits 消耗
  • 组织资源包列表: 分页查询组织名下所有共享资源包的明细,包括激活时间、有效期、初始/已用/剩余额度与状态
  • 席位·月余额批次列表: 分页查询组织名下所有席位·月余额批次的明细,包括来源渠道、剩余数量、生效/到期时间与状态
  • 指定周期席位·月消耗列表: 分页查询组织成员在指定周期内的席位·月消耗情况

API 列表

1. 列出用量事件

GET /v1/organizations/{organization_id}/members/{member_id}/usage-events 分页获取指定成员的聚合 Credits 用量记录。

路径参数

参数类型必填说明
organization_idstring组织 ID
member_idstring成员 ID

查询参数

参数类型必填说明
startDatestring开始时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
endDatestring结束时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
sourcesstring按来源过滤,逗号分隔。可选值:IDECLIJetBrains PluginWebQoderWork
operationsstring按操作过滤,逗号分隔。可选值:Inline ChatAskAgentRepo WikiQuestPlan ModeCode ReviewOptimize InputVoice InputExpertsImage
modelTiersstring按模型等级过滤,逗号分隔。可选值:AutoPerformanceEfficientLiteUltimateVisionQwen-Coder-Qoder-1.0Kimi-K2.5GLM-5MiniMax-M2.5DeepSeek-V4.0Qwen3.5-PlusStandardPremiumEnterprise
maxResultsinteger每页数量(默认 20,最大 100)
nextTokenstring分页游标

成功响应 (200 OK)

有用量记录、有后续页:
部分记录可能不返回 userEmailmodelTier,集成时请按可选字段处理。
无用量记录 / 最后一页:
nextToken 为空时不返回,表示已到最后一页。

响应字段说明

字段类型说明
usagesarray用量记录列表
usages[].timestampint64开始时间(Unix 毫秒时间戳)
usages[].userIdstring用户 ID
usages[].userEmailstring用户邮箱(可能为空)
usages[].sourcestring来源:IDECLIJetBrains PluginWebQoderWork
usages[].operationstring操作:Inline ChatAskAgentRepo WikiQuestPlan ModeCode ReviewOptimize InputVoice InputExpertsImage
usages[].modelTierstring模型等级(可能为空):AutoPerformanceEfficientLiteUltimateVisionQwen-Coder-Qoder-1.0Kimi-K2.5GLM-5MiniMax-M2.5DeepSeek-V4.0Qwen3.5-PlusStandardPremiumEnterprise
usages[].creditsfloat64消耗 Credits(保留两位小数)
usages[].costfloat64账单折算后的成本(保留两位小数),与计费规则相关;通常与 credits 数值一致或存在固定折算关系
maxResultsint32本次请求的每页数量
nextTokenstring下一页游标,为空表示最后一页

2. 获取用量汇总

GET /v1/organizations/{organization_id}/members/{member_id}/usage-summary 按指定维度汇总成员在给定时间范围内的 Credits 消耗。时间范围不得超过 7 天。

路径参数

参数类型必填说明
organization_idstring组织 ID
member_idstring成员 ID

查询参数

参数类型必填说明
startDatestring开始时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
endDatestring结束时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
groupBystring分组维度:source(按来源)或 operation(按操作)

成功响应 (200 OK)

按来源汇总(**groupBy=source**):
按操作汇总(**groupBy=operation**):
无用量数据:

响应字段说明

字段类型说明
summaryobject汇总结果,key 为分组名称(来源或操作),value 为总 Credits
summary.{key}float64该分组的总 Credits 消耗(保留两位小数)

错误响应

缺少必填参数 (400)
时间范围超限 (400)
groupBy 无效 (400)

3. 列出组织用量事件

GET /v1/organizations/{organization_id}/usage-events 分页获取指定组织下所有成员的聚合 Token 用量记录。返回结构与成员用量事件接口一致。

路径参数

参数类型必填说明
organization_idstring组织 ID

查询参数

参数类型必填说明
startDatestring开始时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
endDatestring结束时间,支持 RFC 3339 格式或 Unix 毫秒时间戳
sourcesstring按来源过滤,逗号分隔。可选值:IDECLIJetBrains PluginWebQoderWork
operationsstring按操作过滤,逗号分隔。可选值:Inline ChatAskAgentRepo WikiQuestPlan ModeCode ReviewOptimize InputVoice InputExperts
modelTiersstring按模型等级过滤,逗号分隔。可选值:AutoPerformanceEfficientLiteUltimateVisionQwen-Coder-Qoder-1.0Kimi-K2.5GLM-5MiniMax-M2.5DeepSeek-V4.0Qwen3.5-PlusStandardPremiumEnterprise
maxResultsinteger每页数量(默认 20,最大 100)
nextTokenstring分页游标

成功响应 (200 OK)

部分记录可能不返回 userEmailmodelTier,集成时请按可选字段处理。接口默认与成员用量事件接口保持一致,不额外过滤正向 Credits 记录;退款、冲正等负向记录也可能返回。

响应字段说明

响应字段定义与 「1. 列出成员用量事件」 完全一致。

4. 列出组织共享资源包

GET /v1/organizations/{organization_id}/resource-packages 按组织维度分页返回所有共享资源包明细。响应只包含每个资源包的具体批次信息,不返回汇总(如需汇总,可在客户端对返回的 limitValue / usedValue / remainingValue 自行求和)。

路径参数

参数类型必填说明
organization_idstring组织 ID

查询参数

参数类型必填说明
statusstring按状态过滤。可选值:activeexhaustedexpiredsuspended。不传时返回组织下全部未删除的资源包
orderBystring排序字段。可选值:expiresAt(默认)、activatedAtremainingValue
orderstring排序方向。可选值:asc(默认)、desc
maxResultsinteger每页数量(默认 20,最大 100)
nextTokenstring分页游标。从上一次响应的 nextToken 字段透传

成功响应 (200 OK)

有资源包、有后续页:
部分资源包可能不返回 activatedAt(如尚未激活的批次),集成时请按可选字段处理。
无资源包 / 最后一页:
nextToken 为空时不返回,表示已到最后一页。

响应字段说明

字段类型说明
resourcePackagesarray资源包列表
resourcePackages[].idstring资源包唯一 ID
resourcePackages[].namestring资源包名称
resourcePackages[].sourcestring资源包来源:purchased(购买)、bonus(赠送)、trial(试用)、carryOver(结转)、refund(退款)、dev(开发测试)、sales(销售配置)
resourcePackages[].statusstring资源包状态:active(生效中)、exhausted(额度已用尽)、expired(已过期)、suspended(已暂停)
resourcePackages[].activatedAtstring激活时间(RFC 3339 / ISO 8601 格式,UTC,可能为空)
resourcePackages[].expiresAtstring到期时间(RFC 3339 / ISO 8601 格式,UTC)
resourcePackages[].limitValuefloat64资源包初始总额度
resourcePackages[].usedValuefloat64已消耗额度
resourcePackages[].remainingValuefloat64剩余额度(= limitValue - usedValue
resourcePackages[].unitstring额度单位,常见为 credits
maxResultsint32本次请求的每页数量
nextTokenstring下一页游标,为空时不返回,表示已到最后一页

错误响应

status 参数非法 (400)
orderBy 参数非法 (400)
组织不存在或无权限 (404)

状态说明

资源包状态机如下:
状态说明进入条件
active生效中,可消费资源包激活后默认进入
exhausted已用尽剩余额度归零(注意:已用尽的资源包到期后状态不会自动变为 expired,仍保持 exhausted
expired已过期由系统每小时执行一次的定时任务,将到期的 active 资源包翻转为 expired
suspended已暂停管理端手动操作,暂停后不可消费
由于 expired 状态由小时级定时任务异步刷新,真实到期时刻 → 状态翻转之间存在最长约 1 小时的窗口期,在窗口期内资源包 status 仍为 activeexpiresAt < now。如需做精确的「真实可用」判定,建议在客户端结合 status expiresAt 联合判断

5. 列出组织席位·月余额批次

本接口仅适用于通过三方渠道(如云市场兑换码)购买的组织。
GET /v1/organizations/{organization_id}/seat-month-batches 按组织维度分页返回席位·月余额批次明细。响应只包含每个批次的具体信息,不返回汇总。 席位·月余额不同于成员统计里的 remainingSeatsremainingSeats 仅适用于非三方渠道购买的组织,表示已购席位中剩余可用席位数;席位·月余额表示组织还剩多少可消费的席位·月批次。一个组织可能多次充值席位·月余额,每一笔批次都有独立的剩余数量和到期时间。

路径参数

参数类型必填说明
organization_idstring组织 ID

查询参数

参数类型必填说明
statusstring按状态过滤。可选值:activeexhaustedexpiredrefunded。不传时返回组织下全部批次
pageSizeinteger每页数量(默认 100,最大 500)
pageTokenstring页码游标。翻页时传入上一次响应的 nextToken 字段

成功响应 (200 OK)

有席位·月批次、有后续页:
部分批次可能不返回 redemptionCodeIdsourceChannelthirdPartyInstanceIdproductCode,集成时请按可选字段处理。
无席位·月批次 / 最后一页:
nextToken 为空时不返回,表示已到最后一页。翻页时请把响应里的 nextToken 原样作为下一次请求的 pageToken

响应字段说明

字段类型说明
seatMonthBatchesarray席位·月余额批次列表
seatMonthBatches[].idstring席位·月批次 ID
seatMonthBatches[].redemptionCodeIdstring关联兑换码记录 ID,不是兑换码明文,可能为空
seatMonthBatches[].statusstring批次状态:activeexhaustedexpiredrefunded
seatMonthBatches[].sourceChannelstring来源渠道,例如兑换码、年包返还、云市场等,可能为空
seatMonthBatches[].thirdPartyInstanceIdstring三方实例 ID,可能为空
seatMonthBatches[].productCodestring三方商品码,可能为空
seatMonthBatches[].reportRequiredboolean是否参与云市场用量上报
seatMonthBatches[].totalSeatMonthsfloat64该批次原始席位·月总量
seatMonthBatches[].usedSeatMonthsfloat64该批次已消耗席位·月
seatMonthBatches[].remainingSeatMonthsfloat64该批次剩余席位·月
seatMonthBatches[].effectiveAtstring生效时间(RFC 3339 / ISO 8601 格式,UTC)
seatMonthBatches[].expiresAtstring到期时间(RFC 3339 / ISO 8601 格式,UTC)
seatMonthBatches[].createdAtstring创建时间(RFC 3339 / ISO 8601 格式,UTC)
seatMonthBatches[].updatedAtstring更新时间(RFC 3339 / ISO 8601 格式,UTC)
pageSizeint32本次请求的每页数量
nextTokenstring下一页游标,为空时不返回,表示已到最后一页

如何计算当前可用席位·月余额

接口不直接返回总余额。可以按以下条件筛选批次,再汇总 remainingSeatMonths
例如当前返回 3 个批次:
批次状态剩余席位·月生效时间到期时间是否计入可用余额
Aactive90.0已生效未过期
Bexhausted0.0已生效未过期
Cactive20.0未生效未过期
当前可用席位·月总余额为 90.0

错误响应

status 参数非法 (400)
pageToken 参数非法 (400)

状态说明

状态说明进入条件
active生效中批次创建后默认进入,且尚未被耗尽、过期或退款作废
exhausted已用尽批次剩余额度归零
expired已过期系统过期回收后进入
refunded已退款作废退款或作废流程进入
由于过期状态由后台任务异步刷新,真实到期时刻到状态翻转之间可能存在延迟。如果客户需要精确判断「当前是否可用」,建议同时判断 statuseffectiveAtexpiresAtremainingSeatMonths

6. 查询指定周期席位·月消耗

本接口仅适用于通过三方渠道(如云市场兑换码)购买的组织。返回的是云市场需要认账/上报的实际净消耗,不是组织内部所有席位·月流水(如测试、赠送的额度)。
GET /v1/organizations/{organization_id}/seat-month-usages 按组织维度分页返回指定周期范围内的成员席位·月消耗。响应按成员和计费周期聚合,不返回席位·月批次明细。

计算口径

字段说明
consumedSeatMonths成员在该周期原始消耗的席位·月
refundedSeatMonths成员在该周期已返还、且可归因到原席位和原周期的席位·月
netSeatMonths成员在该周期的实际净消耗
历史边界:接口上线时间为 2026-06-24T16:00:00Z。上线前因缺少部分周期信息,数据无法保证完整性,请以上线后的周期计算为准。

路径参数

参数类型必填说明
organization_idstring组织 ID

查询参数

参数类型必填说明
periodStartstring周期范围开始时间,RFC 3339 格式,例如 2026-06-01T00:00:00Z
periodEndstring周期范围结束时间,RFC 3339 格式,必须晚于 periodStart
memberIdstring按组织成员 ID 过滤
userIdstring按用户 ID 过滤
pageSizeinteger每页数量(默认 100,最大 500)
pageTokenstring页码游标。翻页时传入上一次响应的 nextToken 字段
查询结果只包含满足 periodStart >= 请求 periodStartperiodEnd <= 请求 periodEnd 的完整计费周期。建议使用实际计费周期边界查询。

成功响应 (200 OK)

有席位·月消耗记录、有后续页:
全额返还后 netSeatMonths 可能为 0。例如成员被分配席位后未使用 Credits,后续移除成员时席位·月返还给组织,该成员该周期净消耗为 0。
无席位·月消耗记录 / 最后一页:
nextToken 为空时不返回,表示已到最后一页。翻页时请把响应里的 nextToken 原样作为下一次请求的 pageToken

响应字段说明

字段类型说明
seatMonthUsagesarray成员席位·月消耗列表
seatMonthUsages[].memberIdstring组织成员 ID
seatMonthUsages[].userIdstring用户 ID
seatMonthUsages[].periodStartstring计费周期开始时间,RFC 3339 / ISO 8601 格式
seatMonthUsages[].periodEndstring计费周期结束时间,RFC 3339 / ISO 8601 格式
seatMonthUsages[].consumedSeatMonthsfloat64该成员该周期原始消耗的席位·月
seatMonthUsages[].refundedSeatMonthsfloat64该成员该周期已返还的席位·月
seatMonthUsages[].netSeatMonthsfloat64该成员该周期实际净消耗的席位·月
pageSizeint32本次请求的每页数量
nextTokenstring下一页页码游标,为空时不返回,表示已到最后一页

错误响应

缺少 periodStart 参数 (400)
缺少 periodEnd 参数 (400)
时间格式非法 (400)
时间范围非法 (400)

口径说明

云市场上报口径 本接口返回的是云市场需要认账/上报的实际净消耗,不是组织内部所有席位·月流水。测试、赠送等来源非云市场购买的不需要上报的席位·月记录不会出现在响应中。 返还扣减口径 如果成员在当前周期被移除,且该成员在该周期未使用任何 Credits,系统会将对应席位·月返还给组织余额。满足以下条件的返还会从成员该周期消耗中扣除:
条件说明
同一组织返还记录属于同一个组织
同一席位分配返还记录可以关联到原席位分配 ID
同一计费周期返还记录带有原周期开始和结束时间
返还类型返还流水为 REFUND / INCREASE
排序与分页 结果默认按 periodStart 倒序(较新周期在前)、memberId 升序、userId 升序排列。pageToken 使用响应里的 nextToken 继续翻页;未返回 nextToken 表示没有下一页。

使用示例

列出成员用量事件

按日期范围过滤

列出组织用量事件

按来源和操作过滤

按来源汇总用量

按操作汇总用量

列出组织资源包

资源包翻页查询

nextToken 中可能包含 URL 保留字符,作为 query 参数传递时请做 URL Encode(例如 =%3D)。

列出组织席位·月余额批次

仅查询生效中的席位·月余额批次

席位·月批次翻页查询

pageToken 来自上一页响应的 nextToken

查询指定周期内的席位·月消耗

按成员查询席位·月消耗

席位·月消耗翻页查询

pageToken 来自上一页响应的 nextToken

错误码

错误码HTTP 状态码说明
BadRequest400请求参数无效(如 member_id 为空、日期格式错误、时间范围超限、groupBy 无效、status 非法、pageToken 非法、periodStart/periodEnd 缺失或非法)
Unauthorized401API Key 缺失或无效
Forbidden403无权限访问该组织
NotFound404资源不存在
InternalError500服务器内部错误
错误响应结构见 约定与规范 中的「错误响应」一节。