按指定维度查询用户、积分包或Agent的积分使用情况。
接口说明
请求说明
该 API 用于根据UsageType指定的维度（User / CreditPackage / Agent）查询积分用量详情。返回内容包括当前积分包总量/余量/用量、按小时消耗采样、告警阈值、周期配额等信息。
- User：用户维度，返回当前用户全部生效积分包的合计用量、余量。
- CreditPackage：积分包维度，返回指定积分包实例的总量、余量、消耗采样。
- Agent：Agent 维度，返回指定 Agent 的累计用量、当前周期用量、配额、告警等信息。
注意：
InstanceIds参数在UsageType=User时可省略，在CreditPackage时传积分包实例 ID，在Agent时传 AgentId。- 匿名版请求支持
FillInstance参数，当未显式传入InstanceIds且FillInstance=true时，服务端依据当前登录wyId自动填充已绑定的JVS_COPILOTAgentId。 - 时间窗口常量：
dayUsedCredit统计窗口为now - ONE_DAY_MILLIS，weekUsedCredit统计窗口为now - ONE_WEEK_MILLIS。 - 消耗采样
currentCreditConsumeList按小时聚合，可能存在≤5 分钟的异步同步延迟。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeCreditUsageInfo | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BizType | string | 否 | 业务类型 | BUSINESS |
| UsageType | string | 否 | 用量类型（UseageType）：User、CreditPackage、Agent
| User |
| InstanceIds | array | 否 | 实例 ID 列表 JSON 字符串； | |
| string | 否 | 实例 ID。 | cp-0bszoespx7o1ehjxs |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "68BD3312-53D8-123E-BB32-1A9F25E07A03",
"UsageInfoList": [
{
"UsageInfoKey": "agent-abc",
"UsageInfo": {
"DayUsedCredit": 0,
"WeekUsedCredit": 0,
"TotalUsedCredit": 0,
"TotalCredit": 0,
"RemainCredit": 0,
"CurrentTotalCredit": 0,
"CurrentRemainCredit": 0,
"CurrentUsedCredit": 0,
"CurrentInstanceId": "cp-inst-001",
"CreditTrendList": [
{
"TimePoint": "2026-05-02 10",
"UsedCredit": 12
}
],
"WarnPercent": 80,
"PeriodUsedCredit": 120,
"PeriodTotalCredit": 300
}
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-05-05 | 新增 OpenAPI | 查看变更详情 |