DescribeSiteMonitorList - - Alibaba Cloud Documentation Center

Menanyakan tugas pemantauan situs.

Topik ini memberikan contoh cara menanyakan semua tugas pemantauan situs dalam Akun Alibaba Cloud Anda. Dalam contoh ini, hasil yang dikembalikan menunjukkan bahwa Akun Alibaba Cloud memiliki satu tugas pemantauan situs bernama HanZhou_ECS2.

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	Required	Example	Description
Action	String	Yes	DescribeSiteMonitorList	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeSiteMonitorList.
TaskId	String	No	a1ecd34a-8157-44d9-b060-14950837****	ID task pemantauan situs.
TaskType	String	No	HTTP	Protokol yang digunakan oleh task pemantauan situs. Nilai yang valid: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.
Keyword	String	No	site	Kata kunci yang akan dicocokkan. Catatan Anda dapat mencari task berdasarkan nama atau alamat. Pencarian fuzzy didukung.
Page	Integer	No	1	Nomor halaman. Nilai default: 1.
PageSize	Integer	No	10	Jumlah entri per halaman. Nilai default: 10.
TaskState	String	No	1	Status task. Nilai yang valid: 1: Task diaktifkan. 2: Task dinonaktifkan.

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

Parameter respons

Parameter	Type	Example	Description
RequestId	String	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B	ID permintaan.
Success	String	true	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false
Code	String	200	Kode status. Catatan Kode status 200 menunjukkan bahwa permintaan berhasil.
Message	String	successful	Pesan yang dikembalikan.
PageNumber	Integer	1	Nomor halaman.
PageSize	Integer	10	Jumlah entri per halaman.
TotalCount	Integer	1	Total jumlah entri yang dikembalikan.
SiteMonitors	Array of SiteMonitor		Task pemantauan situs yang dikembalikan.
SiteMonitor
TaskType	String	TCP	Protokol yang digunakan oleh task pemantauan situs. Nilai yang valid: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.
UpdateTime	String	2022-03-08 17:14:31	Waktu saat task pemantauan situs diperbarui.
Interval	String	1	Interval pengiriman permintaan deteksi. Satuan: menit.
TaskState	String	1	Status task. Nilai yang valid: 1: Task diaktifkan. 2: Task dinonaktifkan.
CreateTime	String	2021-11-01 11:05:18	Waktu saat task pemantauan situs dibuat.
TaskName	String	New site monitoring task	Nama task pemantauan situs.
Address	String	https://aliyun.com	URL atau alamat IP yang dipantau oleh task pemantauan situs.
TaskId	String	f5783760-1b39-4b6b-80e8-453d962a****	ID task pemantauan situs.
OptionsJson	Object		Opsi tambahan task pemantauan situs. Opsi ini bervariasi tergantung protokol yang ditentukan. Untuk informasi selengkapnya, lihat CreateSiteMonitor.
password	String	123****	Password protokol SMTP, POP3, atau FTP.
request_format	String	hex	Format permintaan HTTP. Nilai yang valid: hex: heksadesimal txt: teks
response_content	String	cf0f85	Respons terhadap permintaan HTTP. Format heksadesimal: Jika konten permintaan berupa string byte dan tidak dapat direpresentasikan dalam karakter yang dapat dicetak, Anda dapat mengonversi string byte tersebut menjadi karakter yang dapat dicetak dalam format heksadesimal. Jika Anda mengonversi string byte menjadi karakter yang dapat dicetak dalam format heksadesimal, satu byte dikonversi menjadi dua karakter heksadesimal. Misalnya, (byte)1 dikonversi menjadi `01` dan (byte)27 dikonversi menjadi `1B`. Jika konten permintaan berupa array biner dalam format Java, misalnya, `{(byte)1, (byte)27}`, Anda dapat mengonversi array biner tersebut menjadi `011b` atau `011B`. Karakter heksadesimal tidak peka huruf besar/kecil dalam task pemantauan situs. Anda dapat memasukkan `011B` dalam konten permintaan dan menyetel parameter request_format ke hex. Format teks: Teks umum mengacu pada string yang terdiri dari karakter yang dapat dicetak.
failure_rate	Float	0.5	Tingkat kehilangan paket. Catatan Parameter ini hanya dikembalikan jika parameter TaskType disetel ke PING.
time_out	Long	3000	Periode timeout. Satuan: milidetik.
header	String	testKey:testValue	Header permintaan HTTP. Header HTTP merupakan pasangan kunci-nilai di mana kunci dan nilai dipisahkan oleh tanda titik dua (:). Formatnya adalah `key1:value1`. Setiap header HTTP menempati satu baris.
cookie	String	lang=en	Cookie permintaan HTTP.
port	Integer	80	Nomor port protokol TCP, UDP, SMTP, atau POP3.
ping_num	Integer	20	Jumlah hop untuk protokol PING.
authentication	Integer	1	Menunjukkan apakah fitur otentikasi keamanan diaktifkan. Nilai yang valid: 0: Fitur diaktifkan. 1: Fitur dinonaktifkan.
http_method	String	get	Metode permintaan HTTP. Nilai yang valid: get post head
match_rule	Integer	0	Menunjukkan apakah aturan alert disertakan. Nilai yang valid: 0: Aturan alert disertakan. 1: Aturan alert tidak disertakan.
dns_match_rule	String	IN_DNS	Hubungan antara daftar alias atau alamat IP yang diharapkan dengan daftar hasil DNS. Nilai yang valid: 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 dengan daftar nilai yang diharapkan. ANY: Daftar hasil DNS berpotongan dengan daftar nilai yang diharapkan.
request_content	String	cf0f85	Konten permintaan HTTP.
username	String	testUser	Username protokol FTP, SMTP, atau POP3.
response_format	String	hex	Format respons HTTP. Nilai yang valid: hex: heksadesimal txt: teks
dns_type	String	A	Jenis Rekaman DNS. Parameter ini hanya dikembalikan jika parameter TaskType disetel ke DNS. Nilai yang valid: A (default): catatan yang menentukan alamat IP terkait dengan nama host atau Nama domain yang ditentukan. CNAME: catatan yang memetakan beberapa Nama domain ke satu Nama domain. NS: catatan yang menentukan Server DNS yang digunakan untuk mengurai Nama domain. MX: catatan yang menghubungkan Nama domain ke alamat server email. TXT: catatan yang menyimpan informasi teks dari nama host atau Nama domain. Teks harus berukuran 1 hingga 512 byte. Rekaman TXT berfungsi sebagai Rekaman Sender Policy Framework (SPF) untuk melawan spam. AAAA: catatan yang memetakan Nama domain ke Alamat IPv6 terkait.
dns_server	String	192.168.XX.XX	Nama domain atau alamat IP Server DNS.
enable_operator_dns	Boolean	true	Menunjukkan apakah Server DNS penyedia layanan digunakan. true (default): Server DNS penyedia layanan digunakan. false: Server DNS penyedia layanan tidak digunakan. Server DNS default atau Server DNS yang ditentukan digunakan.
attempts	Long	3	Jumlah percobaan ulang setelah terjadi kegagalan DNS.
protocol	String	udp	Jenis protokol deteksi DNS. Nilai yang valid: udp (default) tcp tcp-tls
proxy_protocol	Boolean	false	Menunjukkan apakah protokol PROXY diaktifkan. Nilai yang valid: false (default): Protokol PROXY dinonaktifkan. true: Protokol PROXY diaktifkan.
acceptable_response_code	String	400	Kode status yang dapat diterima. Catatan Kami menyarankan agar Anda mengonfigurasi assertions.
isBase64Encode	String	false	Menunjukkan apakah password didekode menggunakan algoritma Base64. Nilai yang valid: true: Password didekode menggunakan algoritma Base64. false (default): Password tidak didekode menggunakan algoritma Base64.
cert_verify	Boolean	false	Menunjukkan apakah Sertifikat diverifikasi. Nilai yang valid: false (default): Sertifikat tidak diverifikasi. true: Sertifikat diverifikasi.
unfollow_redirect	Boolean	false	Menunjukkan apakah redirect diikuti jika kode status 301 atau 302 dikembalikan. Nilai yang valid: true: Redirect tidak diikuti. false (default): Redirect diikuti.
diagnosis_mtr	Boolean	false	Menunjukkan apakah MTR secara otomatis digunakan untuk mendiagnosis masalah jaringan jika task gagal. Nilai yang valid: false (default): MTR tidak secara otomatis digunakan untuk mendiagnosis masalah jaringan jika task gagal. true: MTR secara otomatis digunakan untuk mendiagnosis masalah jaringan jika task gagal.
diagnosis_ping	Boolean	false	Menunjukkan apakah permintaan ping secara otomatis dikirim untuk mendeteksi latensi jaringan jika task deteksi gagal. Nilai yang valid: false (default): Permintaan ping tidak secara otomatis dikirim untuk mendeteksi latensi jaringan jika task deteksi gagal. true: Permintaan ping secara otomatis dikirim untuk mendeteksi latensi jaringan jika task deteksi gagal.
retry_delay	Integer	1	Jumlah kali permintaan deteksi yang gagal dicoba ulang.
assertions	Array of assertions		Pernyataan.
assertions
property	String	json path	Jalur penguraian assertion. Jika jenis assertion adalah `body_json`, jalurnya adalah `json path`. Jika jenis assertion adalah `body_xml`, jalurnya adalah `xml path`.
type	String	response_time	Jenis assertion. Nilai yang valid: response_time: memeriksa apakah waktu respons sesuai ekspektasi. status_code: memeriksa apakah kode status HTTP sesuai ekspektasi. header: memeriksa apakah bidang dalam Header respons sesuai ekspektasi. body_text: memeriksa apakah konten dalam badan respons sesuai ekspektasi menggunakan pencocokan teks. body_json: memeriksa apakah konten dalam badan respons sesuai ekspektasi menggunakan penguraian JSON (JSONPath). body_xml: memeriksa apakah konten dalam badan respons sesuai ekspektasi menggunakan penguraian XML (XPath).
operator	String	lessThan	Operator perbandingan assertion. Nilai yang valid: contains: berisi doesNotContain: tidak berisi matches: cocok dengan ekspresi reguler doesNotMatch: tidak cocok dengan ekspresi reguler is: sama dengan nilai numerik atau cocok dengan karakter isNot: tidak sama dengan lessThan: kurang dari moreThan: lebih dari
target	String	1000	Nilai numerik atau karakter yang digunakan untuk pencocokan.
AgentGroup	String	PC	Jenis probe. Nilai yang valid: PC MOBILE

Contoh

Permintaan contoh

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

Respons sukses contoh

XML format

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

<DescribeSiteMonitorListResponse>
    <TotalCount>1</TotalCount>
    <RequestId>A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B</RequestId>
    <Message>successful</Message>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Code>200</Code>
    <Success>true</Success>
    <SiteMonitors>
        <SiteMonitor>
            <TaskId>f5783760-1b39-4b6b-80e8-453d962a****</TaskId>
            <Address>https://aliyun.com</Address>
            <EndTime></EndTime>
            <TaskName>test123</TaskName>
            <OptionsJson>
                <response_content></response_content>
                <request_format>hex</request_format>
                <response_format>hex</response_format>
                <request_content>cf0f85</request_content>
                <port>80</port>
            </OptionsJson>
            <TaskType>TCP</TaskType>
            <CreateTime>2021-11-01 11:05:18</CreateTime>
            <UpdateTime>2022-03-08 17:14:31</UpdateTime>
            <TaskState>1</TaskState>
            <Interval>1</Interval>
        </SiteMonitor>
    </SiteMonitors>
</DescribeSiteMonitorListResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Message" : "successful",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Code" : "200",
  "Success" : true,
  "SiteMonitors" : {
    "SiteMonitor" : [ {
      "TaskId" : "f5783760-1b39-4b6b-80e8-453d962a****",
      "Address" : "https://aliyun.com",
      "EndTime" : "",
      "TaskName" : "test123",
      "OptionsJson" : {
        "response_content" : "",
        "request_format" : "hex",
        "response_format" : "hex",
        "request_content" : "cf0f85",
        "port" : 80
      },
      "TaskType" : "TCP",
      "CreateTime" : "2021-11-01 11:05:18",
      "UpdateTime" : "2022-03-08 17:14:31",
      "TaskState" : 1,
      "Interval" : 1
    } ]
  }
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.