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

*全部资源

*

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 HTTP. Catatan Nilai 200 menunjukkan keberhasilan.	200
Message	string	Paket error.	The specified resource is not found.
RequestId	string	ID permintaan.	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	Jumlah total catatan.	1
Success	boolean	Apakah operasi berhasil. Nilai valid: true: Operasi berhasil. false: Operasi gagal.	true
TaskList	object
NodeTaskConfig	array<object>	Daftar tugas pemantauan ketersediaan.
	array<object>	Daftar tugas pemantauan ketersediaan.
TaskType	string	Jenis tugas. Nilai yang valid: PING TELNET HTTP	HTTP
GroupName	string	Nama grup aplikasi.	Group_ECS
GroupId	integer	ID grup aplikasi.	12345
TaskName	string	Nama tugas pemantauan ketersediaan.	ecs_instance
Disabled	boolean	Menunjukkan apakah tugas pemantauan ketersediaan dinonaktifkan. Nilai yang valid: true: Tugas pemantauan ketersediaan dinonaktifkan. false: Tugas pemantauan ketersediaan diaktifkan.	false
TaskScope	string	Rentang instans yang dipantau oleh tugas pemantauan ketersediaan. Nilai yang valid: GROUP: Semua instans ECS dalam grup aplikasi dipantau. GROUP_SPEC_INSTANCE: Instans ECS yang ditentukan dalam grup aplikasi dipantau.	GROUP
Id	integer	ID tugas pemantauan ketersediaan.	123456
Instances	object
Instance	array	Instans ECS yang dipantau.
	string	ID instans ECS.	i-abcdefgh12****
TaskOption	object	Parameter opsional dari tugas pemantauan ketersediaan.
HttpMethod	string	Metode permintaan HTTP. Nilai yang valid: GET POST HEAD	GET
Interval	integer	Interval pengiriman permintaan deteksi. Satuan: detik.	60
HttpURI	string	URI yang ingin Anda pantau. Jika parameter TaskType disetel ke HTTP, parameter ini wajib diisi.	https://www.aliyun.com
TelnetOrPingHost	string	Nama domain atau alamat IP yang ingin Anda pantau.	ssh.aliyun.com
HttpResponseCharset	string	Set karakter yang digunakan dalam respons HTTP.	UTF-8
HttpPostContent	string	Konten permintaan POST HTTP.	params1=paramsValue1
HttpNegative	boolean	Metode untuk memicu peringatan. Peringatan dapat dipicu berdasarkan apakah aturan peringatan yang ditentukan disertakan dalam isi respons. Nilai yang valid: true: Jika isi respons HTTP menyertakan aturan peringatan, peringatan dipicu. false: Jika respons HTTP tidak menyertakan aturan peringatan, peringatan dipicu.	true
HttpKeyword	string	Respons terhadap permintaan HTTP.	OK
AlertConfig	object	Konfigurasi aturan peringatan.
SilenceTime	integer	Periode senyap di mana peringatan baru tidak dikirim meskipun kondisi pemicu terpenuhi. Satuan: detik. Nilai default: 86400.	86400
EndTime	integer	Akhir periode waktu di mana aturan peringatan efektif. Nilai yang valid: 0 hingga 23. Misalnya, jika parameter `AlertConfig.StartTime` disetel ke 0 dan parameter `AlertConfig.EndTime` disetel ke 22, aturan peringatan efektif dari 00:00:00 hingga 22:00:00. Catatan Notifikasi peringatan dikirim berdasarkan ambang batas yang ditentukan hanya jika aturan peringatan efektif.	22
StartTime	integer	Awal periode waktu di mana aturan peringatan efektif. Nilai yang valid: 0 hingga 23. Misalnya, jika parameter `AlertConfig.StartTime` disetel ke 0 dan parameter `AlertConfig.EndTime` disetel ke 22, aturan peringatan efektif dari 00:00:00 hingga 22:00:00. Catatan Notifikasi peringatan dikirim berdasarkan ambang batas yang ditentukan hanya jika aturan peringatan efektif.	0
WebHook	string	URL callback. CloudMonitor mendorong notifikasi peringatan ke URL callback yang ditentukan dengan mengirimkan permintaan POST HTTP. Hanya protokol HTTP yang didukung.	https://www.aliyun.com
NotifyType	integer	Metode notifikasi peringatan. Nilai yang valid: 2: Notifikasi peringatan dikirim menggunakan email dan chatbot DingTalk. 1: Notifikasi peringatan dikirim menggunakan email dan chatbot DingTalk. 0: Notifikasi peringatan dikirim menggunakan email dan chatbot DingTalk.	1
EscalationList	object
escalationList	array<object>	Kondisi pemicu aturan peringatan.
	object
Value	string	Ambang batas peringatan.	400
MetricName	string	Nama metrik. Nilai yang valid: HttpStatus HttpLatency TelnetStatus TelnetLatency PingLostRate	HttpStatus
Operator	string	Operator perbandingan yang digunakan dalam aturan peringatan. Nilai yang valid: `>` `>=` `<` `<=` `=`	=
Times	string	Jumlah berturut-turut nilai metrik diukur sebelum peringatan dipicu.	3
Aggregate	string	Metode yang digunakan untuk menghitung nilai metrik yang memicu peringatan. Nilai yang valid: Value: nilai kode status HTTP Average: waktu respons HTTP rata-rata Value: nilai kode status Telnet TelnetLatency: waktu respons Telnet rata-rata Average: rata-rata tingkat kehilangan paket Ping	Value
TargetList	object
Target	array<object>	Sumber daya yang dipantau.
	object
Id	string	ID sumber daya yang memicu peringatan.	1
Arn	string	Alibaba Cloud Resource Name (ARN) dari fungsi. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Bidang: Service: kode layanan Region: ID region Account: ID akun Alibaba Cloud ResourceType: jenis sumber daya ResourceId: ID sumber daya.	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	Tingkat peringatan. Nilai yang valid: INFO WARN CRITICAL	INFO
JsonParams	string	Parameter callback peringatan dalam format JSON.	{"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
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.