DescribeCreditUsageInfo - Elastic Desktop Service - Alibaba Cloud Documentation Center

Mengkueri penggunaan kredit berdasarkan dimensi tertentu seperti pengguna, paket kredit, atau agen.

Deskripsi operasi

Operasi API ini mengkueri detail penggunaan kredit berdasarkan dimensi yang ditentukan oleh UsageType (User, CreditPackage, atau Agent). Respons mencakup total kredit, kredit tersisa, dan kredit terpakai dari paket kredit saat ini, sampel konsumsi per jam, ambang batas peringatan, kuota periode, dan informasi lainnya.

User: Dimensi pengguna. Mengembalikan penggunaan teragregasi dan kredit tersisa di seluruh paket kredit aktif untuk pengguna saat ini.
CreditPackage: Dimensi paket kredit. Mengembalikan total, kredit tersisa, dan sampel konsumsi untuk instans paket kredit tertentu.
Agent: Dimensi agen. Mengembalikan penggunaan kumulatif, penggunaan periode saat ini, kuota, peringatan, dan informasi lainnya untuk agen tertentu.

Catatan:

Parameter InstanceIds dapat dihilangkan saat UsageType=User. Atur parameter ini ke ID instans paket kredit saat UsageType=CreditPackage, atau ke AgentId saat UsageType=Agent.
Permintaan anonim mendukung parameter FillInstance. Jika InstanceIds tidak ditentukan secara eksplisit dan FillInstance=true, server secara otomatis mengisi AgentId JVS_COPILOT yang terikat berdasarkan wyId yang sedang login.
Konstanta jendela waktu: Jendela statistik dayUsedCredit adalah now - ONE_DAY_MILLIS, dan jendela statistik weekUsedCredit adalah now - ONE_WEEK_MILLIS.
Sampel konsumsi dalam currentCreditConsumeList diagregasi per jam dan mungkin memiliki penundaan sinkronisasi asinkron hingga 5 menit.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

GET  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
BizType	string	No	Jenis bisnis.	BUSINESS
UsageType	string	No	Jenis penggunaan. Nilai valid: User: Mengembalikan penggunaan, kredit tersisa, dan tren konsumsi paket kredit aktif untuk pengguna saat ini. CreditPackage: Memerlukan CreditPackageId. Mengembalikan total dan kredit tersisa dari paket kredit tertentu. Agent: Memerlukan AgentId. Mengembalikan penggunaan kredit kumulatif, kuota teralokasi kumulatif, dan persentase keduanya.	User
InstanceIds	array	No	String JSON ID instans. Parameter ini dapat dihilangkan saat UsageType=User. Atur parameter ini ke ID instans paket kredit saat UsageType=CreditPackage, atau ke AgentId saat UsageType=Agent.
	string	No	ID instans.	cp-0bszoespx7o1ehjxs

Elemen respons

Element	Type	Description	Example
	object	Tipe pengembalian: ListResult.
RequestId	string	ID permintaan.	68BD3312-53D8-123E-BB32-1A9F25E07A03
UsageInfoList	array<object>	Array data penggunaan.
	array<object>
UsageInfoKey	string	Kunci utama penggunaan. Saat UsageType=User, ini adalah aliUid. Saat UsageType=CreditPackage, ini adalah ID instans paket kredit. Saat UsageType=Agent, ini adalah AgentId.	agent-abc
UsageInfo	object	Detail data penggunaan.
DayUsedCredit	integer	Penggunaan kredit dalam 1 hari terakhir.	最近一天消耗积分
WeekUsedCredit	integer	Penggunaan kredit dalam 1 minggu terakhir.	最近一周消耗积分
TotalUsedCredit	integer	Penggunaan kredit kumulatif.	共计消耗积分
TotalCredit	integer	Total kredit kumulatif.	积分配额
RemainCredit	integer	Sisa kredit kumulatif.	积分余量
CurrentTotalCredit	integer	Total kredit dari paket kredit aktif saat ini.	当前周期积分配额
CurrentRemainCredit	integer	Sisa kredit dari paket kredit aktif saat ini.	当前周期积分余量
CurrentUsedCredit	integer	Kredit yang digunakan dari paket kredit aktif saat ini.	当前周期积分消耗
CurrentInstanceId	string	ID instans dari paket kredit aktif saat ini.	cp-inst-001
CreditTrendList	array<object>	Sampel konsumsi per jam dari paket kredit saat ini.
	object
TimePoint	string	Titik waktu dalam format `yyyy-MM-dd HH` (akurat hingga jam).	2026-05-02 10
UsedCredit	integer	Jumlah kredit yang dikonsumsi selama jam tersebut.	12
WarnPercent	integer	Persentase ambang batas peringatan (0–100).	80
PeriodUsedCredit	integer	Penggunaan kredit bersama dalam periode aktif saat ini.	120
PeriodTotalCredit	integer	Kuota kredit bersama dalam periode aktif saat ini.	300
TodayUsed	string
TotalUsed	string

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.