跳转到主要内容

文档说明

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

权限要求

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

概述

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

主要功能

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

API 列表

1. 列出用量事件

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

路径参数

查询参数

成功响应 (200 OK)

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

响应字段说明


2. 获取用量汇总

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

路径参数

查询参数

成功响应 (200 OK)

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

响应字段说明

错误响应

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

3. 列出组织用量事件

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

路径参数

查询参数

成功响应 (200 OK)

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

响应字段说明

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

4. 列出组织共享资源包

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

路径参数

查询参数

成功响应 (200 OK)

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

响应字段说明

错误响应

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

状态说明

资源包状态机如下: 由于 expired 状态由小时级定时任务异步刷新,真实到期时刻 → 状态翻转之间存在最长约 1 小时的窗口期,在窗口期内资源包 status 仍为 activeexpiresAt < now。如需做精确的「真实可用」判定,建议在客户端结合 status expiresAt 联合判断

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

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

路径参数

查询参数

成功响应 (200 OK)

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

响应字段说明

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

接口不直接返回总余额。可以按以下条件筛选批次,再汇总 remainingSeatMonths
例如当前返回 3 个批次: 当前可用席位·月总余额为 90.0

错误响应

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

状态说明

由于过期状态由后台任务异步刷新,真实到期时刻到状态翻转之间可能存在延迟。如果客户需要精确判断「当前是否可用」,建议同时判断 statuseffectiveAtexpiresAtremainingSeatMonths

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

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

计算口径

历史边界:接口上线时间为 2026-06-24T16:00:00Z。上线前因缺少部分周期信息,数据无法保证完整性,请以上线后的周期计算为准。

路径参数

查询参数

查询结果只包含满足 periodStart >= 请求 periodStartperiodEnd <= 请求 periodEnd 的完整计费周期。建议使用实际计费周期边界查询。

成功响应 (200 OK)

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

响应字段说明

错误响应

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

口径说明

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

使用示例

列出成员用量事件

按日期范围过滤

列出组织用量事件

按来源和操作过滤

按来源汇总用量

按操作汇总用量

列出组织资源包

资源包翻页查询

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

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

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

席位·月批次翻页查询

pageToken 来自上一页响应的 nextToken

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

按成员查询席位·月消耗

席位·月消耗翻页查询

pageToken 来自上一页响应的 nextToken

错误码

错误响应结构见 约定与规范 中的「错误响应」一节。