Gunakan DescribeHostAvailabilityList untuk kueri tugas monitoring ketersediaan - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Mengkueri daftar tugas pemantauan ketersediaan.

Deskripsi operasi

Topik ini menyediakan contoh cara mengkueri daftar tugas pemantauan ketersediaan untuk akun saat ini. Tanggapan menunjukkan bahwa akun saat ini memiliki satu catatan tugas pemantauan ketersediaan ecs_instance.

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:DescribeHostAvailabilityList

get

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	No	ID tugas pemantauan ketersediaan.	123456
Ids	string	No	ID beberapa tugas pemantauan ketersediaan. Pisahkan beberapa ID dengan koma (,).	123456,345678
TaskName	string	No	Nama tugas pemantauan ketersediaan.	ecs_instance.
PageNumber	integer	No	Nomor halaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai minimum: 1. Nilai default: 10.	10
GroupId	integer	No	ID kelompok aplikasi.	12345

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

Elemen respons

Element	Type	Description	Example
	object
Code	string	Kode status. Catatan Nilai 200 menunjukkan keberhasilan.	200
Message	string	Paket error.	Sumber daya yang ditentukan tidak ditemukan.
RequestId	string	ID permintaan.	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	Jumlah total catatan.	1
Success	boolean	Apakah operasi berhasil. Nilai valid: true: Berhasil. false: Gagal.	true.
TaskList	object
NodeTaskConfig	array<object>	Daftar tugas pemantauan ketersediaan.
	array<object>	Daftar tugas pemantauan ketersediaan.
TaskType	string	Tipe tugas. Nilai valid: PING TELNET HTTP	HTTP
GroupName	string	Nama kelompok aplikasi.	Group_ECS
GroupId	integer	ID kelompok aplikasi.	12345
TaskName	string	Nama tugas pemantauan ketersediaan.	ecs_instance
Disabled	boolean	Apakah tugas pemantauan ketersediaan dinonaktifkan. Nilai valid: true: Tugas dinonaktifkan. false: Tugas diaktifkan.	false
TaskScope	string	Cakupan (dalam OAuth) tugas pemantauan ketersediaan. Nilai valid: GROUP: Semua instans ECS dalam kelompok aplikasi saat ini digunakan sebagai titik deteksi. GROUP_SPEC_INSTANCE: Instans ECS tertentu dalam kelompok aplikasi saat ini digunakan sebagai titik deteksi.	GROUP
Id	integer	ID tugas pemantauan ketersediaan.	123456
Instances	object
Instance	array	Daftar instans ECS yang memulai deteksi.
	string	Daftar instans ECS yang memulai deteksi.	i-abcdefgh12****
TaskOption	object	Opsi parameter tugas pemantauan ketersediaan.
HttpMethod	string	Metode HTTP dari tipe deteksi. Nilai valid: GET POST HEAD	GET
Interval	integer	Frekuensi deteksi. Unit: detik.	60
HttpURI	string	URI untuk deteksi HTTP.	https://www.aliyun.com
TelnetOrPingHost	string	Nama domain atau alamat yang akan dideteksi.	ssh.aliyun.com
HttpResponseCharset	string	Set karakter tanggapan untuk deteksi HTTP.	UTF-8
HttpPostContent	string	Konten POST dari permintaan deteksi HTTP.	params1=paramsValue1
HttpNegative	boolean	Aturan peringatan untuk pencocokan konten tanggapan HTTP. Nilai valid: true: Pemicu jika konten tanggapan HTTP berisi aturan peringatan yang ditentukan. false: Pemicu jika konten tanggapan HTTP tidak berisi aturan peringatan yang ditentukan.	true
HttpKeyword	string	Kata kunci untuk dicocokkan dalam konten tanggapan deteksi HTTP.	OK
AlertConfig	object	Konfigurasi aturan peringatan.
SilenceTime	integer	Periode bisu. Unit: detik. Nilai default: 86400.	86400
EndTime	integer	Waktu akhir periode efektif Notifikasi. Nilai valid: 0 hingga 23. Misalnya, jika AlertConfig.StartTime diatur ke 0 dan AlertConfig.EndTime diatur ke 22, periode efektif Notifikasi adalah 00:00:00 hingga 22:00:00. Catatan Jika Notifikasi tidak berada dalam periode efektif, Pemberitahuan peringatan tidak dikirim meskipun ambang batas terlampaui.	22
StartTime	integer	Waktu mulai periode efektif Notifikasi. Nilai valid: 0 hingga 23. Misalnya, jika AlertConfig.StartTime diatur ke 0 dan AlertConfig.EndTime diatur ke 22, periode efektif Notifikasi adalah 00:00:00 hingga 22:00:00. Catatan Jika Notifikasi tidak berada dalam periode efektif, Pemberitahuan peringatan tidak dikirim meskipun ambang batas terlampaui.	0
WebHook	string	URL callback ketika Pemicu. CloudMonitor mendorong informasi Pemicu ke URL ini menggunakan permintaan POST. Hanya protokol HTTP yang didukung.	https://www.aliyun.com
NotifyType	integer	Metode notifikasi Pemberitahuan peringatan. Nilai valid: 2: Email + chatbot DingTalk. 1: Email + chatbot DingTalk. 0: Email + chatbot DingTalk.	1
EscalationList	object
escalationList	array<object>	Kondisi yang Pemicu.
	object	Kondisi yang Pemicu.
Value	string	Ambang batas peringatan.	400
MetricName	string	Metrik untuk Pemicu. Nilai valid: HttpStatus: Kode status HTTP. HttpLatency: Waktu loss tanggapan HTTP. TelnetStatus: Kode status TELNET. TelnetLatency: Waktu loss tanggapan TELNET. PingLostRate: Laju kehilangan paket PING.	HttpStatus
Operator	string	Operator perbandingan untuk aturan peringatan. Nilai valid: `>` `>=` `<` `<=` `=`	=
Times	string	Jumlah periode berturut-turut saat ambang batas terlampaui sebelum Pemicu.	3
Aggregate	string	Metode statistik untuk Pemicu. Nilai valid bervariasi berdasarkan metrik: Value: Nilai kode status HTTP. Average: Rata-rata loss tanggapan HTTP. Value: Nilai kode status TELNET. TelnetLatency: Rata-rata loss tanggapan TELNET. Average: Rata-rata laju kehilangan paket PING.	Value
TargetList	object
Target	array<object>	Daftar target peringatan.
	object	Daftar target peringatan.
Id	string	ID target peringatan.	1
Arn	string	Nama Sumber Daya Alibaba Cloud (ARN). Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Bidang dijelaskan sebagai berikut: Service: Kode layanan Alibaba Cloud. Region: ID wilayah. Account: ID akun Alibaba Cloud. ResourceType: Tipe resource. ResourceId: ID resource.	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	Level Pemicu. Nilai valid: INFO: Informasi. WARN: Peringatan. CRITICAL: Kritis.	INFO
JsonParams	string	Parameter berformat JSON dari callback peringatan.	{"key1":"value1"}

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
  "Total": 1,
  "Success": true,
  "TaskList": {
    "NodeTaskConfig": [
      {
        "TaskType": "HTTP",
        "GroupName": "Group_ECS",
        "GroupId": 12345,
        "TaskName": "ecs_instance",
        "Disabled": false,
        "TaskScope": "GROUP",
        "Id": 123456,
        "Instances": {
          "Instance": [
            "i-abcdefgh12****"
          ]
        },
        "TaskOption": {
          "HttpMethod": "GET",
          "Interval": 60,
          "HttpURI": "https://www.aliyun.com",
          "TelnetOrPingHost": "ssh.aliyun.com",
          "HttpResponseCharset": "UTF-8",
          "HttpPostContent": "params1=paramsValue1",
          "HttpNegative": true,
          "HttpKeyword": "OK"
        },
        "AlertConfig": {
          "SilenceTime": 86400,
          "EndTime": 22,
          "StartTime": 0,
          "WebHook": "https://www.aliyun.com",
          "NotifyType": 1,
          "EscalationList": {
            "escalationList": [
              {
                "Value": "400",
                "MetricName": "HttpStatus",
                "Operator": "=",
                "Times": "3",
                "Aggregate": "Value"
              }
            ]
          },
          "TargetList": {
            "Target": [
              {
                "Id": "1",
                "Arn": "acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages",
                "Level": "INFO",
                "JsonParams": "{\"key1\":\"value1\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

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.	Sumber daya %s yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.