DescribeCreditUsageInfo - Elastic Desktop Service - Alibaba Cloud ドキュメントセンター

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

操作説明

操作の説明

この API オペレーションは、UsageType（User、CreditPackage、または Agent）で指定されたディメンションに基づいてクレジット使用量の詳細を照会します。応答には、現在のクレジットパッケージの合計、残り、使用済みクレジット、時間単位の消費サンプル、アラートのしきい値、期間クォータ、およびその他の情報が含まれます。

User: ユーザーディメンション。現在のユーザーのすべてのアクティブなクレジットパッケージにわたる集計使用量と残りクレジットを返します。
CreditPackage: クレジットパッケージディメンション。指定されたクレジットパッケージインスタンスの合計、残り、および消費サンプルを返します。
Agent: エージェントディメンション。指定されたエージェントの累計使用量、現在の期間の使用量、クォータ、アラート、およびその他の情報を返します。

注意事項:

UsageType=User の場合、InstanceIds パラメーターは省略できます。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

*すべてのリソース。

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BizType	string	任意	ビジネスタイプ。	BUSINESS
UsageType	string	任意	使用量タイプ。有効な値: User: 現在のユーザーのアクティブなクレジットパッケージの使用量、残りクレジット、および消費トレンドを返します。 CreditPackage: CreditPackageId が必要です。指定されたクレジットパッケージの合計クレジットと残りクレジットを返します。 Agent: AgentId が必要です。累計クレジット使用量、累計割り当てクォータ、およびそれぞれの割合を返します。	User
InstanceIds	array	任意	インスタンス ID の JSON 文字列。`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` です。	agent-abc
UsageInfo	object	使用量データの詳細。
DayUsedCredit	integer	過去 24 時間のクレジット使用量です。	最近一天消耗积分
WeekUsedCredit	integer	過去 7 日間のクレジット使用量です。	最近一周消耗积分
TotalUsedCredit	integer	合計クレジット使用量です。	共计消耗积分
TotalCredit	integer	合計クレジットクォータです。	积分配额
RemainCredit	integer	クレジット残量です。	积分余量
CurrentTotalCredit	integer	現在アクティブなクレジットパッケージの合計クレジットです。	当前周期积分配额
CurrentRemainCredit	integer	現在アクティブなクレジットパッケージのクレジット残量です。	当前周期积分余量
CurrentUsedCredit	integer	現在アクティブなクレジットパッケージから使用したクレジットです。	当前周期积分消耗
CurrentInstanceId	string	現在アクティブなクレジットパッケージのインスタンス ID です。	cp-inst-001
CreditTrendList	array<object>	現在アクティブなクレジットパッケージの 1 時間ごとのクレジット使用量サンプルのリストです。
	object
TimePoint	string	1 時間ごとのサンプルのタイムスタンプです。形式は`yyyy-MM-dd HH`です。	2026-05-02 10
UsedCredit	integer	その時間に使用したクレジット数です。	12
WarnPercent	integer	アラームのしきい値です。0 から 100 までのパーセンテージで指定します。	80
PeriodUsedCredit	integer	現在の期間における共有クレジットの使用量です。	120
PeriodTotalCredit	integer	現在の期間における共有クレジットのクォータです。	300
TodayUsed	string
TotalUsed	string

例

成功レスポンス

JSONJSON

{
  "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": ""
      }
    }
  ]
}

エラーコード

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

変更履歴

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