按指定维度查询用户、积分包或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代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:DescribeCreditUsageInfo |
get |
*全部资源
|
无 | 无 |
请求语法
GET HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BizType |
string |
否 |
业务类型 |
BUSINESS |
| UsageType |
string |
否 |
用量类型(UseageType):User、CreditPackage、Agent
|
User |
| InstanceIds |
array |
否 |
实例 ID 列表 JSON 字符串; |
|
|
string |
否 |
实例 ID。 |
cp-0bszoespx7o1ehjxs |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回类型: |
||
| RequestId |
string |
请求 ID |
68BD3312-53D8-123E-BB32-1A9F25E07A03 |
| UsageInfoList |
array<object> |
业务数据数组 |
|
|
array<object> |
|||
| UsageInfoKey |
string |
用量主键: |
agent-abc |
| UsageInfo |
object |
用量数据详情 |
|
| DayUsedCredit |
integer |
最近 1 天积分用量 |
最近一天消耗积分 |
| WeekUsedCredit |
integer |
最近 1 周积分用量 |
最近一周消耗积分 |
| TotalUsedCredit |
integer |
累计积分用量 |
共计消耗积分 |
| TotalCredit |
integer |
累计积分总量 |
积分配额 |
| RemainCredit |
integer |
累计计费余量 |
积分余量 |
| CurrentTotalCredit |
integer |
当前生效积分包总量 |
当前周期积分配额 |
| CurrentRemainCredit |
integer |
当前生效积分包余量 |
当前周期积分余量 |
| CurrentUsedCredit |
integer |
当前生效积分包用量 |
当前周期积分消耗 |
| CurrentInstanceId |
string |
当前生效积分包实例 ID |
cp-inst-001 |
| CreditTrendList |
array<object> |
当前积分包按小时消耗采样(见下) |
|
|
object |
|||
| TimePoint |
string |
时间点,格式 |
2026-05-02 10 |
| UsedCredit |
integer |
该小时消耗积分数 |
12 |
| WarnPercent |
integer |
告警阈值百分比(0–100) |
80 |
| PeriodUsedCredit |
integer |
当前生效周期的共享积分用量 |
120 |
| PeriodTotalCredit |
integer |
当前生效周期的共享积分配额 |
300 |
| TodayUsed |
string |
||
| TotalUsed |
string |
示例
正常返回示例
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,
"TodayUsed": "",
"TotalUsed": ""
}
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。