DescribeHostAvailabilityList - - Alibaba Cloud Documentation Center

Kueri task pemantauan ketersediaan.

Topik ini memberikan contoh cara mengkueri semua task pemantauan ketersediaan dalam Akun Alibaba Cloud Anda. Respons contoh menunjukkan bahwa akun tersebut memiliki satu task pemantauan ketersediaan bernama ecs_instance.

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 kode contoh operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Yes	DescribeHostAvailabilityList	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeHostAvailabilityList.
Id	Long	No	123456	ID task pemantauan ketersediaan.
Ids	String	No	123456,345678	ID task pemantauan ketersediaan. Pisahkan beberapa ID dengan koma (,).
TaskName	String	No	ecs_instance	Nama task pemantauan ketersediaan.
PageNumber	Integer	No	1	Nomor halaman yang akan dikembalikan. Halaman dimulai dari halaman 1. Nilai default: 1.
PageSize	Integer	No	10	Jumlah entri yang dikembalikan per halaman. Nilai default: 10.
GroupId	Long	No	12345	ID kelompok aplikasi.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
RequestId	String	4A288E86-45C3-4858-9DB0-6D85B10BD92A	ID permintaan.
Code	String	200	Kode status HTTP. Catatan Nilai 200 menunjukkan bahwa panggilan berhasil.
Success	Boolean	true	Menunjukkan apakah panggilan berhasil. Nilai yang valid: true: Panggilan berhasil. false: Panggilan gagal.
TaskList	Array of NodeTaskConfig		Detail task pemantauan ketersediaan.
NodeTaskConfig
AlertConfig	Struct		Konfigurasi aturan peringatan.
EndTime	Integer	22	Akhir periode waktu saat aturan peringatan berlaku. Nilai yang valid: 0 hingga 23. Misalnya, jika parameter `AlertConfig.StartTime` diatur ke 0 dan parameter `AlertConfig.EndTime` diatur ke 22, aturan peringatan berlaku dari pukul 00:00:00 hingga 22:00:00. Catatan Pemberitahuan peringatan hanya dikirim berdasarkan ambang batas yang ditentukan jika aturan peringatan sedang berlaku.
EscalationList	Array of escalationList		Kondisi pemicu aturan peringatan.
escalationList
Aggregate	String	Value	Metode yang digunakan untuk menghitung nilai metrik yang memicu peringatan. Nilai yang valid: Value: nilai kode status HTTP Average: rata-rata waktu respons HTTP Value: nilai kode status Telnet TelnetLatency: rata-rata waktu respons Telnet Average: rata-rata tingkat kehilangan paket Ping
MetricName	String	HttpStatus	Nama metrik. Nilai yang valid: HttpStatus: kode status HTTP HttpLatency: waktu respons HTTP TelnetStatus: kode status Telnet TelnetLatency: waktu respons Telnet PingLostRate: tingkat kehilangan paket Ping
Operator	String	=	Operator perbandingan yang digunakan dalam aturan peringatan. Nilai yang valid: `>` `>=` `<` `<=` `=`
Times	String	3	Jumlah kali berturut-turut pengukuran nilai metrik sebelum peringatan dipicu.
Value	String	400	Ambang batas peringatan.
NotifyType	Integer	1	Metode notifikasi peringatan. Nilai yang valid: 0: Pemberitahuan peringatan dikirim melalui email dan chatbot DingTalk.
SilenceTime	Integer	86400	Periode bisu selama notifikasi peringatan baru tidak dikirim meskipun kondisi pemicu terpenuhi. Satuan: detik. Nilai default: 86400.
StartTime	Integer	0	Awal periode waktu saat aturan peringatan berlaku. Nilai yang valid: 0 hingga 23. Misalnya, jika parameter `AlertConfig.StartTime` diatur ke 0 dan parameter `AlertConfig.EndTime` diatur ke 22, aturan peringatan berlaku dari pukul 00:00:00 hingga 22:00:00. Catatan Pemberitahuan peringatan hanya dikirim berdasarkan ambang batas yang ditentukan jika aturan peringatan sedang berlaku.
WebHook	String	https://www.aliyun.com	URL callback. CloudMonitor mendorong pemberitahuan peringatan ke URL callback yang ditentukan dengan mengirim permintaan HTTP POST. Hanya protokol HTTP yang didukung.
Disabled	Boolean	false	Menunjukkan apakah task pemantauan ketersediaan dinonaktifkan. Nilai yang valid: true: Task pemantauan ketersediaan dinonaktifkan. false: Task pemantauan ketersediaan diaktifkan.
GroupId	Long	12345	ID kelompok aplikasi.
GroupName	String	Group_ECS	Nama kelompok aplikasi.
Id	Long	123456	ID task pemantauan ketersediaan.
Instances	List	i-abcdefgh12****	Instance ECS yang dipantau.
TaskName	String	ecs_instance	Nama task pemantauan ketersediaan.
TaskOption	Struct		Parameter opsional task pemantauan ketersediaan.
HttpKeyword	String	OK	Respons terhadap permintaan HTTP.
HttpMethod	String	GET	Metode permintaan HTTP. Nilai yang valid: GET POST HEAD
HttpNegative	Boolean	true	Metode untuk memicu peringatan. Peringatan dapat dipicu berdasarkan apakah aturan peringatan yang ditentukan termasuk dalam badan respons. Nilai yang valid: true: Jika badan respons HTTP mencakup aturan peringatan, peringatan dipicu. false: Jika respons HTTP tidak mencakup aturan peringatan, peringatan dipicu.
HttpPostContent	String	params1=paramsValue1	Konten permintaan HTTP POST.
HttpResponseCharset	String	UTF-8	Set karakter yang digunakan dalam respons HTTP.
HttpURI	String	https://www.aliyun.com	URI yang ingin Anda pantau. Jika parameter TaskType diatur ke HTTP, parameter ini wajib diisi.
Interval	Integer	60	Interval pengiriman permintaan deteksi. Satuan: detik.
TelnetOrPingHost	String	ssh.aliyun.com	Nama domain atau alamat IP yang ingin Anda pantau.
TaskScope	String	GROUP	Rentang instance yang dipantau oleh task pemantauan ketersediaan. Nilai yang valid: GROUP: Semua instance ECS dalam kelompok aplikasi dipantau. GROUP_SPEC_INSTANCE: Instance ECS tertentu dalam kelompok aplikasi dipantau.
TaskType	String	HTTP	Jenis task pemantauan ketersediaan. Nilai yang valid: PING TELNET HTTP
Total	Integer	1	Total jumlah entri yang dikembalikan.
Message	String	The specified resource is not found.	Pesan kesalahan.

Contoh

Permintaan contoh

http(s)://[Endpoint]/?Action=DescribeHostAvailabilityList
&<Common request parameters>

Respons sukses contoh

XML format

<DescribeHostAvailabilityListResponse>
	  <RequestId>4A288E86-45C3-4858-9DB0-6D85B10BD92A</RequestId>
	  <Total>1</Total>
	  <TaskList>
		    <NodeTaskConfig>
			      <GroupName>Group_ECS</GroupName>
			      <TaskOption>
				        <HttpURI>https://aliyun.com</HttpURI>
				        <HttpMethod>GET</HttpMethod>
			      </TaskOption>
			      <AlertConfig>
				        <NotifyType>1</NotifyType>
				        <SilenceTime>86400</SilenceTime>
				        <EndTime>22</EndTime>
				        <StartTime>0</StartTime>
				        <EscalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpStatus</MetricName>
						            <Times>3</Times>
						            <Value>400</Value>
						            <Aggregate>Value</Aggregate>
					          </escalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpLatency</MetricName>
						            <Times>3</Times>
						            <Value>500</Value>
						            <Aggregate>Average</Aggregate>
					          </escalationList>
				        </EscalationList>
			      </AlertConfig>
			      <TaskName>ecs_instance</TaskName>
			      <TaskScope>GROUP</TaskScope>
			      <TaskType>HTTP</TaskType>
			      <Id>123456</Id>
			      <Disabled>false</Disabled>
			      <GroupId>12345</GroupId>
		    </NodeTaskConfig>
	  </TaskList>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeHostAvailabilityListResponse>

JSON format

{
	"RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
	"Total": 1,
	"TaskList": {
		"NodeTaskConfig": [
			{
				"GroupName": "Group_ECS",
				"TaskOption": {
					"HttpURI": "https://aliyun.com",
					"HttpMethod": "GET"
				},
				"AlertConfig": {
					"NotifyType": 1,
					"SilenceTime": 86400,
					"EndTime": 22,
					"StartTime": 0,
					"EscalationList": {
						"escalationList": [
							{
								"Operator": "=",
								"MetricName": "HttpStatus",
								"Times": 3,
								"Value": "400",
								"Aggregate": "Value"
							},
							{
								"Operator": "=",
								"MetricName": "HttpLatency",
								"Times": 3,
								"Value": "500",
								"Aggregate": "Average"
							}
						]
					}
				},
				"TaskName": "ecs_instance",
				"TaskScope": "GROUP",
				"TaskType": "HTTP",
				"Id": 123456,
				"Disabled": false,
				"GroupId": 12345
			}
		]
	},
	"Code": 200,
	"Success": true
}

Kode kesalahan

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

Untuk daftar kode kesalahan, kunjungi API Error Center.