DescribeMetricTop - - Alibaba Cloud Documentation Center

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

Batasan

Setiap operasi API dapat dipanggil hingga 10 kali per detik. Kuota ini dibagi bersama oleh Akun Alibaba Cloud dan Pengguna RAM dalam akun tersebut.

Perhatian

Durasi penyimpanan data pemantauan setiap layanan cloud bergantung pada parameter Period (periode statistik). Semakin besar nilai parameter Period, semakin luas rentang waktu data pemantauan dan semakin lama durasi penyimpanannya. Hubungan spesifiknya adalah sebagai berikut:

Jika nilai parameter Period kurang dari 60 detik, durasi penyimpanan adalah tujuh hari.
Jika nilai parameter Period adalah 60 detik, durasi penyimpanan adalah 31 hari.
Jika nilai parameter Period adalah 300 detik, durasi penyimpanan adalah 91 hari.

Catatan penggunaan

Topik ini memberikan contoh cara mengkueri data pemantauan metrik cpu_idle dalam 60 detik terakhir untuk Elastic Compute Service (ECS). Namespace ECS adalah acs_ecs_dashboard. Data pemantauan diurutkan secara menurun berdasarkan bidang Average.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeMetricTop	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeMetricTop.
Period	String	Tidak	60	Periode statistik data pemantauan. Nilai yang 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 tergantung pada metrik yang ditentukan oleh `MetricName`. Untuk informasi selengkapnya, lihat Lampiran 1: Metrik.
Namespace	String	Ya	acs_ecs_dashboard	Namespace layanan cloud. Untuk informasi selengkapnya tentang namespace layanan cloud, lihat Lampiran 1: Metrik.
MetricName	String	Ya	cpu_idle	Metrik yang digunakan untuk memantau layanan cloud. Untuk informasi selengkapnya tentang nama metrik, lihat Lampiran 1: Metrik.
StartTime	String	Tidak	2021-05-08 08:00:00	Awal rentang 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 rentang waktu yang ditentukan akan dikueri. Contoh berikut menunjukkan cara menentukan periode pengkuerian data pemantauan: Jika Anda menetapkan parameter `Period` ke 15, rentang 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 15 detik terakhir dalam rentang waktu tersebut akan dikueri. Jika Anda menetapkan parameter `Period` ke 60 atau 900, rentang 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 60 detik terakhir dalam rentang waktu tersebut akan dikueri. Jika Anda menetapkan parameter `Period` ke 3600, rentang 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 3.600 detik terakhir dalam rentang waktu tersebut akan dikueri. Format berikut didukung: Stempel waktu UNIX: jumlah milidetik sejak 00:00:00 Kamis, 1 Januari 1970 Format waktu: YYYY-MM-DDThh:mm:ssZ Catatan Anda harus menetapkan parameter `StartTime` ke titik waktu setelah 00:00:00 Kamis, 1 Januari 1970. Jika tidak, parameter ini tidak valid. Kami menyarankan Anda menggunakan stempel waktu UNIX untuk mencegah masalah terkait zona waktu.
EndTime	String	Tidak	2021-05-08 10:00:00	Akhir rentang 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 rentang waktu yang ditentukan akan dikueri. Contoh berikut menunjukkan cara menentukan periode pengkuerian data pemantauan: Jika Anda menetapkan parameter `Period` ke 15, rentang 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 15 detik terakhir dalam rentang waktu tersebut akan dikueri. Jika Anda menetapkan parameter `Period` ke 60 atau 900, rentang 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 60 detik terakhir dalam rentang waktu tersebut akan dikueri. Jika Anda mengatur parameter `Period` ke 3600, rentang waktu yang ditentukan harus kurang dari atau sama dengan dua hari. Misalnya, jika Anda mengatur parameter StartTime ke 2021-05-08 08:00:00 dan parameter EndTime ke 2021-05-10 08:00:00, data pemantauan 3.600 detik terakhir dalam rentang waktu tersebut akan diambil. Format berikut didukung: Stempel waktu UNIX: jumlah milidetik sejak 00:00:00 Kamis, 1 Januari 1970 Format waktu: YYYY-MM-DDThh:mm:ssZ Catatan Kami menyarankan Anda menggunakan stempel waktu UNIX untuk mencegah masalah terkait zona waktu.
Dimensions	String	Tidak	[{"instanceId": "i-2ze2d6j5uhg20x47****"}]	Dimensi pemantauan resource yang ditentukan. Tetapkan nilainya ke kumpulan pasangan `key:value`. Contoh: `{"userId":"120886317861**"}` atau `{"instanceId":"i-2ze2d6j5uhg20x47"}`. Catatan** Anda dapat mengkueri maksimal 50 instans dalam satu permintaan.
Orderby	String	Ya	Average	Bidang yang menjadi dasar pengurutan data. Nilai yang valid: Average: nilai rata-rata Minimum: nilai minimum Maximum: nilai maksimum
OrderDesc	String	Tidak	False	Urutan pengurutan data. Nilai yang valid: True: mengurutkan data secara menaik. False (default): mengurutkan data secara menurun.
Length	String	Tidak	10	Jumlah entri per halaman. Nilai default: 10. Catatan Nilai maksimum parameter Length dalam satu permintaan adalah 1440.
Express	String	Tidak	{"groupby":["userId","instanceId"]}	Ekspresi yang digunakan untuk menghitung hasil kueri secara real time. Catatan Hanya ekspresi `groupby` yang didukung. Ekspresi ini mirip dengan pernyataan GROUP BY yang digunakan dalam database.

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Parameter umum.

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
Code	String	200	Kode status. Catatan Kode status 200 menunjukkan bahwa permintaan berhasil.
Message	String	The specified resource is not found.	Pesan kesalahan.
RequestId	String	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42	ID permintaan.
Datapoints	String	[{\"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}]	Data pemantauan.
Period	String	60	Periode statistik data pemantauan. Unit: detik. Nilai yang valid: 15, 60, 900, dan 3600.

Contoh

Contoh permintaan

http(s)://[Endpoint]/?Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&Period=60
&Orderby=Average
&OrderDesc=False
&<Common request parameters>

Contoh respons sukses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricTopResponse>
    <RequestId>18DC44ED-B058-49B0-9D49-1D6608328E4D</RequestId>
    <Period>60</Period>
    <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}]</Datapoints>
    <Code>200</Code>
</DescribeMetricTopResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "18DC44ED-B058-49B0-9D49-1D6608328E4D",
  "Period" : "60",
  "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}]",
  "Code" : "200"
}

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
404	ResourceNotFound	The specified resource is not found.	Resource yang ditentukan tidak ditemukan.

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.