すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:DescribeCreditPackageAgents

    ドキュメントセンター

    Elastic Desktop Service:DescribeCreditPackageAgents

    最終更新日:May 27, 2026

    エージェントの一覧とその使用量情報を照会します。

    操作説明

    注意事項

    • ページネーション：この API は、NextToken および MaxResults パラメーターを使用したページネーションをサポートします。最初のリクエストでは、NextToken を空の文字列に設定します。

    • フィルタリング：AgentType、AgentIds、および Status パラメーターを使用して、結果をフィルタリングできます。

    • ソート：デフォルトでは、結果は AgentId の昇順でソートされます。

    • 並べ替え：デフォルトでは、結果は id で昇順に並べ替えられます。

    • 匿名エディション用の追加パラメーター: FillInstance パラメーターは、現在のユーザーに関連付けられている JVS_COPILOT エージェントの ID を自動的に入力します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecd:DescribeCreditPackageAgents

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BizType

    string

    任意

    ビジネスタイプです。

    BUSINESS
    AgentType

    string

    任意

    エージェントタイプです。有効な値：CREDIT_PACKAGE、JVS_CLAW、OPEN_CLAW、JVS_COPILOT。

    JVS_COPILOT
    AgentIds

    array

    任意

    照会対象のエージェント ID の配列です。例：["agent-1","agent-2"]

    string

    任意

    エージェント ID です。

    jvs-xxxx
    MaxResults

    integer

    任意

    1 ページあたりの最大結果数です。

    100
    NextToken

    string

    任意

    結果の次のページを取得するためのトークンです。この値は、前回のレスポンスの NextToken パラメーターから取得します。最初のリクエストでは、このパラメーターを空の文字列に設定します。

    eyJvZmZzZXQiOjIwfQ==

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマです。

    RequestId

    string

    リクエスト ID です。サポートに問い合わせる際にこの ID を提供してください。

    xxxx-xxxx-xxxx
    Agents

    array<object>

    エージェントの一覧です。

    object

    AgentId

    string

    エージェントの ID です。

    agent-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=="
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。