CreateSiteMonitor - - Alibaba Cloud Documentation Center

Membuat task pemantauan situs.

Topik ini memberikan contoh cara membuat task pemantauan situs bernama HanZhou_ECS1. Task tersebut memantau URL https://www.aliyun.com dengan jenis task HTTPS.

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 untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	CreateSiteMonitor	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke CreateSiteMonitor.
Address	String	Ya	https://www.aliyun.com	URL atau alamat IP yang dipantau oleh task.
TaskType	String	Ya	HTTPS	Jenis task pemantauan situs. Nilai yang valid: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.
TaskName	String	Ya	HanZhou_ECS1	Nama task pemantauan situs. Nama harus terdiri dari 4 hingga 100 karakter, dan dapat berisi huruf, angka, serta garis bawah (_).
Interval	String	Tidak	1	Interval pengiriman permintaan deteksi. Nilai yang valid: 1, 5, 15, 30, dan 60. Satuan: menit. Nilai default: 1.
IspCities	String	Tidak	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]	Informasi titik deteksi. Jika Anda tidak mengisi parameter ini, sistem akan memilih tiga titik deteksi secara acak. Nilainya berupa array JSON. Contoh: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. Nilai pada field city masing-masing merepresentasikan Beijing, Hangzhou, dan Qingdao. Untuk informasi cara mendapatkan titik deteksi, lihat DescribeSiteMonitorISPCityList.
OptionsJson	String	Tidak	{"time_out":5000}	Opsi tambahan protokol yang digunakan oleh task pemantauan situs. Opsi ini berbeda-beda tergantung protokolnya.
AlertIds	String	Tidak	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	ID aturan alert. Untuk informasi cara mendapatkan ID aturan alert, lihat DescribeMetricRuleList.

Tabel berikut menjelaskan opsi tambahan untuk protokol HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP yang ditentukan oleh parameter TaskType.

HTTP atau HTTPS

Parameter	Type	Deskripsi
http_method	String	Metode permintaan HTTP atau HTTPS. Nilai yang valid: GET, POST, dan HEAD. Nilai default: GET.
header	String	Header HTTP kustom yang dipisahkan dengan line feed (\n). Setiap header harus sesuai dengan protokol HTTP. Setiap header harus berupa pasangan kunci-nilai di mana kunci dan nilai dipisahkan oleh tanda titik dua (:).
cookie	String	Cookie HTTP yang ditentukan sesuai standar permintaan HTTP.
request_content	String	Konten permintaan. Konten dapat dalam format JSON atau form. Jika parameter ini tidak ditentukan, badan permintaan akan kosong.
response_content	String	Konten respons yang diharapkan. Selama pemantauan situs, 64 byte pertama dari konten yang dikembalikan oleh server HTTP akan diperiksa.
match_rule	String	0: Jika respons tidak berisi konten yang ditentukan oleh parameter response_content, deteksi berhasil. 1: Jika respons berisi konten yang ditentukan oleh parameter response_content, deteksi berhasil.
username	String	Jika parameter username ditentukan, permintaan HTTP akan berisi header autentikasi dasar (basic authentication).
password	String	Password yang digunakan untuk mengotentikasi permintaan HTTP atau HTTPS.
time_out	int	Periode timeout. Satuan: milidetik. Nilai default: 5.
max_redirect	int	Jumlah maksimum pengalihan (redirection). Nilai default adalah 5 untuk titik deteksi yang berjalan pada instans Elastic Compute Service (ECS) dan 2 untuk titik deteksi yang disediakan oleh penyedia layanan (carrier). Untuk menonaktifkan pengalihan, tetapkan nilainya ke 0. Nilai yang valid: 0 hingga 50.

PING

Parameter

Type

Deskripsi

failure_rate

Text

Jika laju ping gagal melebihi nilai parameter ini, deteksi gagal dan kode status 610 atau 615 dikembalikan. Pesan kesalahan untuk kode status 610 adalah PingAllFail dan untuk kode status 615 adalah PingPartialFail.

Nilai default: 0,1.

ping_num

int

Jumlah kali alamat yang dipantau diping. Nilai default: 10.

Nilai yang valid: 1 hingga 100.

Parameter	Type	Deskripsi
dns_server	string	Nama domain atau alamat IP server Domain Name System (DNS).
dns_type	string	Jenis rekaman DNS yang dikueri. Nilai yang valid: A, NS, CNAME, MX, TXT, ANY, dan AAAA.
expect_value	string	Daftar nilai yang diharapkan. Pisahkan nilai yang diharapkan dengan spasi.
match_rule	string	Hubungan antara daftar nilai yang diharapkan dan daftar hasil DNS. Jika kedua daftar tidak memenuhi hubungan yang ditentukan, deteksi gagal. Nilai yang valid: String kosong atau IN_DNS: Daftar nilai yang diharapkan merupakan subset dari daftar hasil DNS. DNS_IN: Daftar hasil DNS merupakan subset dari daftar nilai yang diharapkan. EQUAL: Daftar hasil DNS sama persis dengan daftar nilai yang diharapkan. ANY: Terdapat irisan antara daftar hasil DNS dan daftar nilai yang diharapkan.

Parameter	Type	Deskripsi
port	int	Nomor port server FTP. Jika parameter ini tidak ditentukan, nilai default digunakan. Nomor port default adalah 21 untuk FTP dan 990 untuk FTPS.
username	string	Username yang digunakan untuk login ke server FTP. Jika parameter ini tidak ditentukan, login anonim digunakan.
password	string	Password yang digunakan untuk login ke server FTP.

POP3 atau SMTP

Parameter	Type	Deskripsi
port	int	Nomor port server POP3 atau SMTP. Nomor port default adalah 110 untuk POP3, 995 untuk POPS3, dan 25 untuk SMTP.
username	string	Username yang digunakan untuk login ke server POP3 atau SMTP. Username dan password untuk login ke server POP3 atau SMTP wajib diisi.
password	string	Password yang digunakan untuk login ke server POP3 atau SMTP. Username dan password untuk login ke server POP3 atau SMTP wajib diisi.

TCP atau UDP

Parameter	Type	Deskripsi
port	int	Nomor port server TCP atau UDP.
request_content	string	Konten permintaan. Jika parameter request_format diatur ke hex, nilai parameter request_content diurai dalam format heksadesimal.
request_format	string	Jika parameter request_format diatur ke nilai lain, nilai parameter request_content dikirim ke server TCP atau UDP sebagai string biasa.
response_content	string	Konten respons. Jika respons dari server TCP atau UDP tidak berisi konten yang ditentukan oleh parameter response_content, deteksi gagal. Jika parameter response_format diatur ke hex, nilai parameter response_content diurai dalam format heksadesimal. Jika parameter response_format diatur ke nilai lain, nilai parameter response_content diurai sebagai string biasa.

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	200	Kode status HTTP. Catatan Kode status 200 menunjukkan bahwa panggilan berhasil.
Message	String	Successful	Pesan yang dikembalikan.
RequestId	String	68192f5d-0d45-4b98-9724-892813f86c71	ID permintaan.
Success	String	true	Menunjukkan apakah panggilan berhasil. Nilai yang valid: true: Panggilan berhasil. false: Panggilan gagal.
Data	Object		Hasil task pemantauan situs.
AttachAlertResult	Array of Contact		Hasil yang dikembalikan setelah Anda mengaitkan aturan alert yang ada dengan task pemantauan situs.
Contact
Code	String	200	Kode status yang dikembalikan setelah Anda mengaitkan aturan alert yang ada dengan task pemantauan situs. Catatan Kode status 200 menunjukkan bahwa panggilan berhasil.
Message	String	successful	Pesan yang dikembalikan setelah Anda mengaitkan aturan alert yang ada dengan task pemantauan situs.
RequestId	String	5dd33455-4f65-4b0c-9200-33d66f3f340b	ID permintaan yang dikirim untuk mengaitkan aturan alert yang ada dengan task pemantauan situs.
Success	String	true	Menunjukkan apakah aturan alert yang ada berhasil dikaitkan dengan task pemantauan situs. Nilai yang valid: true false
RuleId	String	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	ID aturan alert.
CreateResultList	Array of CreateResultList		Hasil permintaan. Jika task pemantauan situs berhasil dibuat, hasil akan dikembalikan. Jika pembuatan task pemantauan situs gagal, tidak ada hasil yang dikembalikan.
CreateResultList
TaskId	String	2c8dbdf9-a3ab-46a1-85a4-f094965e****	ID task pemantauan situs.
TaskName	String	HanZhou_ECS1	Nama task pemantauan situs.

Contoh

Permintaan contoh

http(s)://[Endpoint]/?Action=CreateSiteMonitor
&Address=https://www.aliyun.com
&TaskName=HanZhou_ECS1
&TaskType=HTTPS
&<Common request parameters>

Respons sukses contoh

XML format

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

<CreateSiteMonitorResponse>
	<Message>successful</Message>
	<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>
	<Data>
		<AttachAlertResult>
			<Contact>
				<Message>successful</Message>
				<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>
				<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>
				<Code>200</Code>
				<Success>true</Success>
			</Contact>
		</AttachAlertResult>
	</Data>
	<Code>200</Code>
	<CreateResultList>
		<CreateResultList>
			<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>
			<TaskName>HanZhou_ECS1</TaskName>
		</CreateResultList>
	</CreateResultList>
	<Success>true</Success>
</CreateSiteMonitorResponse>

JSON format

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

{
  "Message" : "successful",
  "RequestId" : "68192f5d-0d45-4b98-9724-892813f86c71",
  "Data" : {
    "AttachAlertResult" : {
      "Contact" : [ {
        "Message" : "successful",
        "RequestId" : "5dd33455-4f65-4b0c-9200-33d66f3f340b",
        "RuleId" : "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent",
        "Code" : "200",
        "Success" : true
      } ]
    }
  },
  "Code" : "200",
  "CreateResultList" : {
    "CreateResultList" : [ {
      "TaskId" : "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName" : "HanZhou_ECS1"
    } ]
  },
  "Success" : true
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.