All Products
Search
Document Center

Cloud Monitor:DescribeMetricTop

Last Updated:Jun 11, 2026

Mengkueri data pemantauan terbaru dari sebuah metrik untuk layanan cloud. Data dapat diurutkan berdasarkan urutan yang ditentukan.

Deskripsi operasi

Limits

  • The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see Enable the pay-as-you-go billing method.

  • Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.

Precautions

The storage duration of the monitoring data of each cloud service is related to the Period parameter (statistical period). A larger value of the Period parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:

  • The storage duration is 7 days if the value of the Period parameter is less than 60 seconds.

  • The storage duration is 31 days if the value of the Period parameter is 60 seconds.

  • The storage duration is 91 days if the value of the Period is greater than or equal to 300 seconds.

Operation description

This topic provides an example on how to query the monitoring data of the cpu_idle metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is acs_ecs_dashboard. The monitoring data is sorted in descending order based on the Average field.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

cms:QueryMetricTop

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

Period

string

No

Periode statistik data pemantauan.

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

Unit: detik.

Catatan
  • Jika parameter ini tidak ditentukan, data pemantauan dikueri berdasarkan periode pelaporan nilai metrik.

  • Periode statistik bervariasi berdasarkan metrik yang ditentukan oleh MetricName. Untuk informasi lebih lanjut, lihat Lampiran 1: Metrik.

60

Namespace

string

Yes

Namespace layanan cloud.

Untuk informasi lebih lanjut tentang namespace layanan cloud, lihat Lampiran 1: Metrik.

acs_ecs_dashboard

MetricName

string

Yes

Metrik yang digunakan untuk memantau layanan cloud.

Untuk informasi lebih lanjut tentang nama metrik, lihat Lampiran 1: Metrik.

cpu_idle

StartTime

string

No

Awal pengatur waktu untuk mengkueri data pemantauan.

  • Jika parameter StartTime dan EndTime tidak ditentukan, data pemantauan dari periode statistik terakhir akan dikueri.

  • Jika parameter StartTime dan EndTime ditentukan, data pemantauan dari periode statistik terakhir dalam pengatur waktu yang ditentukan akan dikueri.

    • Jika Anda menetapkan parameter Period ke 15, pengatur waktu yang ditentukan harus kurang dari atau sama dengan 20 menit. Misalnya, jika Anda menetapkan parameter StartTime ke 2021-05-08 08:10:00 dan parameter EndTime ke 2021-05-08 08:30:00, data pemantauan dari 15 detik terakhir dalam pengatur waktu akan dikueri.

    • Jika Anda menetapkan parameter Period ke 60 atau 900, pengatur waktu yang ditentukan harus kurang dari atau sama dengan 2 jam. Misalnya, jika Anda menetapkan parameter Period ke 60, parameter StartTime ke 2021-05-08 08:00:00, dan parameter EndTime ke 2021-05-08 10:00:00, data pemantauan dari 60 detik terakhir dalam pengatur waktu akan dikueri.

    • Jika Anda menetapkan parameter Period ke 3600, pengatur waktu yang ditentukan harus kurang dari atau sama dengan dua hari. Misalnya, jika Anda menetapkan parameter StartTime ke 2021-05-08 08:00:00 dan parameter EndTime ke 2021-05-10 08:00:00, data pemantauan dari 3.600 detik terakhir dalam pengatur waktu akan dikueri.

Format berikut didukung:

  • Stempel waktu UNIX: jumlah milidetik yang telah berlalu sejak 00:00:00 Kamis, 1 Januari 1970.

  • Format waktu: YYYY-MM-DDThh:mm:ssZ

Catatan
  • Anda harus menetapkan parameter StartTime ke titik waktu yang lebih lambat dari 00:00:00 Kamis, 1 Januari 1970. Jika tidak, parameter ini tidak valid.

  • Gunakan stempel waktu UNIX untuk mencegah masalah terkait zona waktu.

2021-05-08 08:00:00

EndTime

string

No

Akhir pengatur waktu untuk mengkueri data pemantauan.

  • Jika parameter StartTime dan EndTime tidak ditentukan, data pemantauan dari periode statistik terakhir akan dikueri.

  • Jika parameter StartTime dan EndTime ditentukan, data pemantauan dari periode statistik terakhir dalam pengatur waktu yang ditentukan akan dikueri.

    • Jika Anda menetapkan parameter Period ke 15, pengatur waktu yang ditentukan harus kurang dari atau sama dengan 20 menit. Misalnya, jika Anda menetapkan parameter StartTime ke 2021-05-08 08:10:00 dan parameter EndTime ke 2021-05-08 08:30:00, data pemantauan dari 15 detik terakhir dalam pengatur waktu akan dikueri.

    • Jika Anda menetapkan parameter Period ke 60 atau 900, pengatur waktu yang ditentukan harus kurang dari atau sama dengan 2 jam. Misalnya, jika Anda menetapkan parameter Period ke 60, parameter StartTime ke 2021-05-08 08:00:00, dan parameter EndTime ke 2021-05-08 10:00:00, data pemantauan dari 60 detik terakhir dalam pengatur waktu akan dikueri.

    • Jika Anda menetapkan parameter Period ke 3600, pengatur waktu yang ditentukan harus kurang dari atau sama dengan dua hari. Misalnya, jika Anda menetapkan parameter StartTime ke 2021-05-08 08:00:00 dan parameter EndTime ke 2021-05-10 08:00:00, data pemantauan dari 3.600 detik terakhir dalam pengatur waktu akan dikueri.

Format berikut didukung:

  • Stempel waktu UNIX: jumlah milidetik yang telah berlalu sejak 00:00:00 Kamis, 1 Januari 1970.

  • Format waktu: YYYY-MM-DDThh:mm:ssZ

Catatan

Gunakan stempel waktu UNIX untuk mencegah masalah terkait zona waktu.

2021-05-08 10:00:00

Dimensions

string

No

Dimensi pemantauan resource yang ditentukan.

Tetapkan nilai ke kumpulan pasangan kunci:nilai. Contoh: {"userId":"120886317861****"} atau {"instanceId":"i-2ze2d6j5uhg20x47****"}.

Catatan

Anda dapat mengkueri maksimum 50 instans di setiap permintaan.

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

Orderby

string

Yes

Bidang yang digunakan untuk mengurutkan data. Nilai valid:

  • Average

  • Minimum

  • Maximum.

Average

OrderDesc

string

No

Urutan pengurutan data. Nilai valid:

  • True: mengurutkan data dalam urutan menaik.

  • False (default): mengurutkan data dalam urutan menurun.

false

Length

string

No

Jumlah entri per halaman.

Nilai default: 10.

Catatan

Nilai maksimum parameter Length di permintaan adalah 1440.

10

Express

string

No

Ekspresi yang digunakan untuk menghitung hasil kueri secara waktu nyata.

Catatan

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

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

Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element

Type

Description

Example

object

Code

string

The HTTP status code.

Catatan

The status code 200 indicates that the request was successful.

200

Message

string

The error message.

The specified resource is not found.

RequestId

string

The request ID.

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

Datapoints

string

The monitoring data.

[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-j6ccf7d5fn335qpo****\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-0xii2bvf42iqvxbp****\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]

Period

string

The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600.

60

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Datapoints": "[{\\\"order\\\":1,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-j6ccf7d5fn335qpo****\\\",\\\"Average\\\":99.92,\\\"Minimum\\\":99.5,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0},{\\\"order\\\":2,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-0xii2bvf42iqvxbp****\\\",\\\"Average\\\":99.91,\\\"Minimum\\\":99.0,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0}]",
  "Period": "60"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 ParameterInvalid Illegal parameters.
500 InternalError The request processing has failed due to some unknown error.
403 AccessForbidden User not authorized to operate on the specified resource.
404 ResourceNotFound The specified resource is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.