現在のユーザー名配下のエージェントリストおよび使用量のまとめ情報を照会します。
操作説明
リクエストの説明
ページングのサポート: ページングには
NextTokenおよびMaxResultsパラメーターを使用します。最初のリクエストではNextTokenに空文字列を設定します。フィルター: 返されるエージェントリストをフィルターするには、
AgentTypeおよびAgentIdsパラメーターを使用します。ステータスによるフィルター: エージェントをステータスでフィルターするには、
Statusパラメーターを使用します (0: 削除済み、1: アクティブな)。ソート: デフォルトでは、結果は
idの昇順でソートされます。匿名エディション用の追加パラメーター:
FillInstanceパラメーターは、現在ログインしているユーザーにバインドされている JVS_COPILOT AgentId を自動的に設定します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BizType |
string |
任意 |
ビジネスタイプ。 |
BUSINESS |
| AgentType |
string |
任意 |
エージェントタイプ。有効な値: |
JVS_COPILOT |
| AgentIds |
array |
任意 |
エージェント ID リストの JSON 文字列。例: |
|
|
string |
任意 |
AgentId のリスト。 |
jvs-xxxx |
|
| MaxResults |
integer |
任意 |
ページサイズ。 |
100 |
| NextToken |
string |
任意 |
ページネーショントークン。最初のリクエストではこのパラメーターに空文字列を設定します。後続のリクエストでは、前の応答の |
eyJvZmZzZXQiOjIwfQ== |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
トラブルシューティングに使用されるリクエストトレース ID。 |
xxxx-xxxx-xxxx |
| Agents |
array<object> |
エージェントリスト。 |
|
|
object |
|||
| AgentId |
string |
エージェント ID。 |
エージェント-abc |
| InstanceType |
string |
インスタンスタイプ。 |
jvs-copilot.standard |
| CreatedTime |
string |
インスタンスの作成時間。 |
2026-04-01 10:00:00 |
| ExpiredTime |
string |
インスタンスの有効期限切れ時間。 |
2026-10-01 10:00:00 |
| UsedCredit |
integer |
使用されたクレジット量。 |
100 |
| TotalCredit |
integer |
クレジットの総数。 |
2000 |
| CreditPackageId |
string |
現在アクティブなクレジットパッケージインスタンスの ID。 |
cp-inst-001 |
| WarnPercent |
integer |
アラートのしきい値のパーセンテージ (0～100)。 |
80 |
| MaxResults |
integer |
ページサイズ。 |
20 |
| NextToken |
string |
ページネーショントークン。最初のリクエストではこのパラメーターに空文字列を設定します。後続のリクエストでは、前の応答の |
eyJvZmZzZXQiOjIwfQ== |
例
成功レスポンス
JSONJSON
{
"RequestId": "xxxx-xxxx-xxxx",
"Agents": [
{
"AgentId": "agent-abc",
"InstanceType": "jvs-copilot.standard",
"CreatedTime": "2026-04-01 10:00:00",
"ExpiredTime": "2026-10-01 10:00:00",
"UsedCredit": 100,
"TotalCredit": 2000,
"CreditPackageId": "cp-inst-001",
"WarnPercent": 80
}
],
"MaxResults": 20,
"NextToken": "eyJvZmZzZXQiOjIwfQ=="
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。