全部产品
Search
文档中心

Cloud Monitor:DescribeMetricList

更新时间:Jan 22, 2026

Operasi DescribeMetricList melakukan kueri terhadap data pemantauan metrik tertentu untuk layanan cloud.

Deskripsi operasi

Batasan

  • Anda memiliki kuota gratis sebanyak 1 juta panggilan API per bulan untuk operasi DescribeMetricLast, DescribeMetricList, DescribeMetricData, dan DescribeMetricTop secara total. Jika kuota gratis habis dan Anda belum mengaktifkan metode penagihan pay-as-you-go untuk CloudMonitor Basic, Anda tidak dapat lagi menggunakan operasi API tersebut. Namun, jika Anda telah mengaktifkan metode penagihan bayar sesuai penggunaan, Anda tetap dapat menggunakan operasi API tersebut setelah kuota gratis habis. Panggilan API yang melebihi kuota gratis akan dikenai biaya secara otomatis berdasarkan skema bayar sesuai penggunaan. Untuk informasi selengkapnya, lihat Aktifkan pay-as-you-go.

  • Anda dapat memanggil setiap operasi API hingga 50 kali per detik. Batasan ini berlaku bersama untuk Akun Alibaba Cloud dan Pengguna RAM-nya.

Catatan

Jika Anda menerima pesan error Throttling.User atau Request was denied due to user flow control saat memanggil operasi API, panggilan tersebut mengalami pembatasan kecepatan. Untuk informasi selengkapnya, lihat Bagaimana cara mengatasi masalah pembatasan kecepatan panggilan API?.

Catatan

Durasi penyimpanan data pemantauan untuk layanan cloud bergantung pada Period (periode statistik). Semakin besar nilai Period, semakin rendah granularitas data pemantauan dan semakin lama durasi penyimpanannya. Hubungan tersebut adalah sebagai berikut:

  • Jika nilai Period kurang dari 60 detik, durasi penyimpanannya adalah 7 hari.

  • Jika nilai Period adalah 60 detik, durasi penyimpanannya adalah 31 hari.

  • Jika nilai Period adalah 300 detik atau lebih besar, durasi penyimpanannya adalah 91 hari.

Catatan penggunaan

Topik ini memberikan contoh cara melakukan kueri terhadap data pemantauan metrik cpu_idle untuk layanan cloud acs_ecs_dashboard. Respons menampilkan data untuk instans i-abcdefgh12****, yang dimiliki oleh Akun Alibaba Cloud 120886317861****. Dengan interval 60 detik, nilai maksimum, minimum, dan rata-rata metrik tersebut masing-masing adalah 100, 93,1, dan 99,52.

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.

Parameter permintaan

Parameter

Type

Required

Description

Example

Namespace

string

Yes

Namespace layanan cloud.

Untuk informasi selengkapnya, lihat Metrics.

acs_ecs_dashboard

MetricName

string

Yes

Nama metrik.

Untuk informasi selengkapnya, lihat Metrics.

cpu_idle

Period

string

No

Periode statistik data pemantauan.

Nilai yang valid: 15, 60, 900, dan 3600.

Unit: detik.

Catatan
  • Jika Anda tidak mengatur parameter ini, periode pelaporan yang ditentukan saat metrik didaftarkan akan digunakan.

  • Periode statistik setiap metrik (MetricName) dari layanan cloud berbeda-beda. Untuk informasi selengkapnya, lihat Metrics.

60

StartTime

string

No

Awal rentang waktu untuk kueri. Format berikut didukung:

  • Stempel waktu UNIX: jumlah milidetik yang telah berlalu sejak pukul 00:00:00 UTC pada 1 Januari 1970.

  • Format: YYYY-MM-DD hh:mm:ss.

Catatan
  • Rentang waktu merupakan interval terbuka di kiri dan tertutup di kanan. Nilai `StartTime` harus lebih awal daripada nilai `EndTime`.

  • Interval antara `StartTime` dan `EndTime` harus kurang dari atau sama dengan 31 hari.

2019-01-30 00:00:00

EndTime

string

No

Akhir rentang waktu untuk kueri. Format berikut didukung:

  • Stempel waktu UNIX: jumlah milidetik yang telah berlalu sejak pukul 00:00:00 UTC pada 1 Januari 1970.

  • Format: YYYY-MM-DD hh:mm:ss.

Catatan

Interval antara `StartTime` dan `EndTime` harus kurang dari atau sama dengan 31 hari.

2019-01-30 00:10:00

Dimensions

string

No

Dimensi yang menentukan resource yang akan dipantau.

Format: kumpulan pasangan kunci-nilai, seperti {"userId":"120886317861****"} dan {"instanceId":"i-2ze2d6j5uhg20x47****"}.

Catatan

Satu permintaan dapat digunakan untuk melakukan kueri maksimal 50 instans.

[{"instanceId":"i-2ze2d6j5uhg20x47****"}]

NextToken

string

No

Kursor paginasi.

Catatan

Jika Anda tidak mengatur parameter ini, halaman pertama data akan dikembalikan. Jika nilai dikembalikan untuk parameter ini, artinya masih ada data tambahan yang tersedia. Untuk mengambil halaman berikutnya, gunakan nilai yang dikembalikan tersebut sebagai `NextToken` dalam permintaan berikutnya. Nilai null menunjukkan bahwa semua data telah diambil.

15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****

Length

string

No

Jumlah entri yang dikembalikan pada setiap halaman untuk kueri terpaginasi.

Catatan

Nilai maksimum `Length` dalam satu permintaan adalah 1440.

1000

Express

string

No

Ekspresi yang digunakan untuk komputasi real-time berdasarkan hasil kueri.

Catatan

Hanya ekspresi groupby yang didukung. Ekspresi ini mirip dengan pernyataan GROUP BY pada database.

{"groupby":["userId","instanceId"]}

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Common parameters.

Elemen respons

Element

Type

Description

Example

object

NextToken

string

Kursor paginasi.

15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****

RequestId

string

ID permintaan.

3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

Success

boolean

Menunjukkan apakah operasi berhasil. Nilai yang valid:

  • true: Operasi berhasil.

  • false: Operasi gagal.

true

Datapoints

string

Daftar data pemantauan.

[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

Code

string

Kode status.

Catatan

Nilai 200 menunjukkan bahwa panggilan berhasil.

200

Message

string

Pesan error.

The specified resource is not found.

Period

string

Periode statistik. Unit: detik. Nilai yang valid: 60, 300, dan 900.

60

Contoh

Respons sukses

JSONformat

{
  "NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "Period": "60"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 %s %s
500 InternalError The request processing has failed due to some unknown error.
403 %s %s
404 ResourceNotFound The specified resource is not found. The specified resource is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.