すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:DescribeCreditUsageInfo

    ドキュメントセンター

    Elastic Desktop Service:DescribeCreditUsageInfo

    最終更新日:Aug 18, 2026

    ユーザー、クレジットパッケージ、エージェントなどのディメンションを指定して、クレジット使用量の詳細を照会します。

    操作説明

    リクエストの説明

    この API は、UsageType (User / CreditPackage / Agent) で指定したディメンションに基づいてクレジット使用量の詳細を照会します。レスポンスには、合計クレジット、残りのクレジット、使用済みクレジット、時間単位の消費サンプル、アラートのしきい値、および期間クォータが含まれます。

    • User：ユーザーのディメンション。現在のユーザーに対して、すべてのアクティブなクレジットパッケージにまたがる集計された使用量と残りのクレジットを返します。

    • CreditPackage：クレジットパッケージのディメンション。指定したクレジットパッケージのインスタンスについて、合計クレジット、残りのクレジット、および消費サンプルを返します。

    • Agent：エージェントのディメンション。指定したエージェントについて、累積使用量、現在の期間の使用量、クォータ、およびアラート情報を返します。

    注：

    • InstanceIds パラメーターは UsageType=User の場合に省略できます。UsageType=CreditPackage の場合はクレジットパッケージのインスタンス ID を、UsageType=Agent の場合は AgentId をこのパラメーターに渡します。

    • 匿名リクエストでは FillInstance パラメーターを利用できます。InstanceIds が明示的に指定されておらず、かつ FillInstance=true の場合、サーバーは現在のログイン wyId に基づいて、バインドされた JVS_COPILOT AgentId を自動的に設定します。

    • タイムウィンドウ定数：dayUsedCredit の統計ウィンドウは now - ONE_DAY_MILLIS で、weekUsedCredit の統計ウィンドウは now - ONE_WEEK_MILLIS です。

    • currentCreditConsumeList の消費サンプルは時間単位で集計されており、最大 5 分の非同期同期の遅延が発生する場合があります。

    今すぐお試しください

    この 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:DescribeCreditUsageInfo

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BizType

    string

    任意

    ビジネスタイプ。

    BUSINESS
    UsageType

    string

    任意

    使用タイプ。有効な値：

    • User：ユーザーの現在アクティブなクレジットパッケージの使用量、残りのクレジット、および消費の傾向を返します。

    • CreditPackage：CreditPackageId が必要です。指定したクレジットパッケージの合計クレジットと残りのクレジットを返します。

    • Agent：AgentId が必要です。累積クレジット使用量、累積割り当て済みクォータ、およびそれらの割合を返します。

    User
    InstanceIds

    array

    任意

    JSON 配列形式のインスタンス ID リストです。UsageType=User の場合、このパラメーターは省略できます。UsageType=CreditPackage の場合はクレジットパッケージのインスタンス ID を渡し、UsageType=Agent の場合は AgentId を渡します。

    string

    任意

    インスタンス ID。

    cp-0bszoespx7o1ehjxs

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    戻り値の型： ListResult<CreditUsageInfoModel>

    RequestId

    string

    リクエスト ID。

    68BD3312-53D8-123E-BB32-1A9F25E07A03
    UsageInfoList

    array<object>

    使用状況データの配列。

    array<object>

    UsageInfoKey

    string

    使用量のプライマリーキーです。UsageType=User の場合は aliUid、UsageType=CreditPackage の場合はクレジットパッケージのインスタンス ID、UsageType=Agent の場合は AgentId です。

    エージェント-abc
    UsageInfo

    object

    使用状況データの詳細。

    DayUsedCredit

    integer

    過去 1 日間のクレジット使用量。

    過去 1 日に消費されたクレジット数
    WeekUsedCredit

    integer

    過去 1 週間のクレジット使用量。

    過去 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

    時点 (yyyy-MM-dd HH フォーマット、時単位)。

    2026-05-02 10
    UsedCredit

    integer

    この 1 時間に消費されたクレジット数。

    12
    WarnPercent

    integer

    アラートのしきい値 (パーセント単位、0～100)。

    80
    PeriodUsedCredit

    integer

    現在の有効期間における共有クレジットの使用量。

    120
    PeriodTotalCredit

    integer

    現在の有効期間における共有クレジットのクォータ。

    300
    TodayUsed

    string

    本日使用されたクォータ。

    TotalUsed

    string

    累積使用済みクォータ。

    ContactGroupNames

    array

    string

    LastTriggeredAt

    string

    AvailableAmount

    integer

    RemainCreditInfo

    object

    DeductingAmount

    integer

    PendingAmount

    integer

    CurrentInstanceExpiredTime

    string

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "68BD3312-53D8-123E-BB32-1A9F25E07A03",
  "UsageInfoList": [
    {
      "UsageInfoKey": "エージェント-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": "",
        "ContactGroupNames": [
          ""
        ],
        "LastTriggeredAt": "",
        "AvailableAmount": 0,
        "RemainCreditInfo": {
          "DeductingAmount": 0,
          "PendingAmount": 0
        },
        "CurrentInstanceExpiredTime": ""
      }
    }
  ]
}

    エラーコード

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

    変更履歴

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