View a markdown version of this page

GetLabels - Amazon CloudWatch

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

GetLabels

GetLabelsOperasi mengembalikan nama label yang ada di penyimpanan metrik, atau mengembalikan nilai untuk nama label tertentu.

Kata kerja HTTP yang valid

GET, POST untuk/api/v1/labels.

GETuntuk/api/v1/label/label_name/values.

URI yang valid

/api/v1/labels— mengembalikan daftar nama label.

/api/v1/label/label_name/values— mengembalikan daftar nilai untuk label tertentu.

URL permintaan lengkap menggabungkan host CloudWatch pemantauan untuk AWS Wilayah dengan jalur operasi, misalnyahttps://monitoring.AWS Region.amazonaws.com/api/v1/labels. Untuk informasi tentang titik akhir, penandatanganan, dan izin IAM yang diperlukan, lihat. Kueri PromQL

Parameter kueri URL

Parameter berikut diteruskan dalam string kueri URL untuk GET permintaan, atau sebagai bidang isi yang dikodekan formulir untuk permintaan. POST

Parameter Berlaku untuk Deskripsi

match[]

Keduanya

Tidak wajib. Pemilih seri yang membatasi seri mana yang dipertimbangkan saat menghitung hasilnya. Selector mendukung exact match (=), not equal (!=), regex match (=~), dan negative regex match (). !~ Tentukan match[] satu kali atau lebih untuk menggabungkan penyeleksi. Untuk informasi selengkapnya tentang sintaks pemilih, lihat. Kueri PromQL

start

Keduanya

Tidak wajib. Mulai dari rentang waktu untuk dipertimbangkan, sebagai stempel waktu RFC 3339 atau stempel waktu Unix.

end

Keduanya

Tidak wajib. Akhir rentang waktu yang perlu dipertimbangkan, sebagai stempel waktu RFC 3339 atau stempel waktu Unix.

limit

Keduanya

Tidak wajib. Jumlah maksimum label unik untuk dikembalikan, dari 1 ke10000. Jika Anda tidak menentukanlimit, CloudWatch mengembalikan hingga maksimum (10.000). Lihat Batas hasil.

Izin IAM yang diperlukan

Untuk memanggil GetLabels di salah satu jalur, identitas panggilan harus memiliki tindakan IAM berikut:

  • cloudwatch:ListMetrics

Untuk pemetaan tindakan IAM lengkap untuk semua operasi PromQL, lihat. Izin IAM untuk PromQL

Batas hasil

Satu /api/v1/labels atau /api/v1/label/label_name/values respons dapat mengembalikan hingga 10.000 label. Untuk meminta hasil yang lebih sedikit, berikan limit parameter dengan nilai dari 1 ke10000. Jika Anda tidak menentukanlimit, CloudWatch kembali hingga maksimum.

Ketika label yang cocok melebihi batas, respons terpotong dan pesan disertakan dalam bidang Prometheus standar. warnings Kode status HTTP tetap ada200.

Untuk daftar lengkap batas PromQL, termasuk TPS, konkurensi, dan jendela pemindaian 24 jam, lihat. Batas dan batasan PromQL

Permintaan sampel

Buat daftar semua nama label dengan POST permintaan dan badan kosong:

POST /api/v1/labels HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Content-Type: application/x-www-form-urlencoded Content-Length: 0 Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36

Panggilan yang sama denganawscurl:

awscurl --service monitoring --region us-east-1 \ -X POST 'https://monitoring.us-east-1.amazonaws.com/api/v1/labels' \ -H 'Content-Type: application/x-www-form-urlencoded'

Daftar nama label yang cocok dengan pemilih. Pemilih dan rentang waktu diteruskan sebagai bidang yang dikodekan formulir di badan permintaan:

awscurl --service monitoring --region us-east-1 \ -X POST 'https://monitoring.us-east-1.amazonaws.com/api/v1/labels' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'match[]={"http.server.active_requests","@aws.region"=~"us-.*"}&start=1780662000&end=1780665600'

Buat daftar nilai untuk @resource.service.name label. Nama label adalah bagian dari jalur URL dan dikodekan persen (→). @ %40 Jalur ini hanya mendukungGET:

GET /api/v1/label/%40resource.service.name/values HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36

Panggilan yang sama denganawscurl:

awscurl --service monitoring --region us-east-1 \ 'https://monitoring.us-east-1.amazonaws.com/api/v1/label/@resource.service.name/values'

Sampel tanggapan

Respons yang berhasil menggunakan amplop Prometheus JSON standar. dataBidang adalah array string.

Tanggapan untuk/api/v1/labels:

HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "data": [ "__name__", "@aws.account", "@aws.region", "@resource.service.name", "@resource.cloud.region", "InstanceId" ] }

Tanggapan untuk/api/v1/label/label_name/values:

HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "data": [ "myservice", "checkout-api", "billing-worker" ] }