按指定維度查詢使用者、積分包或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 |
*All Resource
|
無 | 無 |
請求文法
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": ""
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。