Gunakan DescribeSiteMonitorList untuk kueri tugas monitoring situs-Cloud Monitor-Alibaba Cloud - Cloud Monitor

Mengkueri daftar tugas pemantauan situs dengan memanggil operasi DescribeSiteMonitorList.

Deskripsi operasi

Topik ini menyediakan contoh cara mengkueri daftar tugas pemantauan situs untuk akun saat ini. Tanggapan menunjukkan bahwa akun saat ini memiliki satu tugas pemantauan situs bernama HanZhou_ECS2.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TaskId	string	No	ID tugas pemantauan situs.	a1ecd34a-8157-44d9-b060-14950837****
TaskType	string	No	Tipe tugas pemantauan situs. CloudMonitor mendukung tipe berikut: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.	HTTP
Keyword	string	No	Kata kunci yang digunakan untuk mencari tugas pemantauan situs. Catatan Pencocokan kabur didukung berdasarkan nama tugas atau alamat tugas.	site
Page	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10
TaskState	string	No	Status tugas. Nilai valid: 1: Normal. 2: Dinonaktifkan.	1
AgentGroup	string	No	Tipe titik deteksi yang digunakan oleh tugas. Nilai valid: PC: Titik deteksi berbasis PC. MOBILE: Titik deteksi berbasis seluler. FC: Titik deteksi internal.	PC

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

Elemen respons

Element	Type	Description	Example
	object	Tidak ada.
RequestId	string	ID permintaan.	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
Success	string	Apakah operasi berhasil. Nilai valid: true: Berhasil. false: Gagal.	true
Code	string	Kode status HTTP. Catatan Nilai 200 menunjukkan keberhasilan.	200
Message	string	Paket yang dikembalikan.	successful
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
TotalCount	integer	Jumlah total entri.	1
SiteMonitors	object
SiteMonitor	array<object>	Daftar tugas pemantauan situs.
	array<object>	Tidak ada.
TaskType	string	Protokol yang digunakan oleh tugas pemantauan situs. Nilai yang valid: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.	TCP
UpdateTime	string	Waktu ketika tugas pemantauan situs diperbarui.	2022-03-08 17:14:31
Interval	string	Interval pengiriman permintaan deteksi. Satuan: menit.	1
TaskState	string	Status tugas. Nilai yang valid: 1: Tugas diaktifkan. 2: Tugas dinonaktifkan.	1
CreateTime	string	Waktu ketika tugas pemantauan situs dibuat.	2021-11-01 11:05:18
TaskName	string	Nama tugas pemantauan situs.	New monitoring task
Address	string	URL atau alamat IP yang dipantau oleh tugas pemantauan situs.	https://aliyun.com
TaskId	string	ID tugas pemantauan situs.	f5783760-1b39-4b6b-80e8-453d962a****
OptionsJson	object	Opsi yang diperluas dari tugas pemantauan situs. Opsi bervariasi berdasarkan protokol yang ditentukan. Untuk informasi lebih lanjut, lihat CreateSiteMonitor.
password	string	Kata sandi protokol SMTP, POP3, atau FTP.	123****
request_format	string	Format permintaan HTTP. Nilai yang valid: hex: heksadesimal txt: teks	hex
response_content	string	Respons permintaan HTTP. Format heksadesimal: Jika konten permintaan adalah string byte dan tidak dapat direpresentasikan dalam karakter yang dapat dicetak, Anda dapat mengonversi string byte 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 adalah array biner dalam format Java, misalnya, `{(byte)1, (byte)27}`, Anda dapat mengonversi array biner menjadi `011b` atau `011B`. Karakter heksadesimal tidak peka huruf besar/kecil dalam tugas 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.	cf0f85
failure_rate	number	Tingkat kehilangan paket. Catatan Parameter ini hanya dikembalikan jika parameter TaskType disetel ke PING.	0.5
time_out	integer	Periode batas waktu. Satuan: milidetik.	3000
header	string	Header permintaan HTTP. Header HTTP adalah pasangan kunci-nilai di mana kunci dan nilai dipisahkan oleh titik dua (:). Formatnya adalah `key1:value1`. Setiap header HTTP menempati satu baris.	testKey:testValue
cookie	string	Cookie permintaan HTTP.	lang=en
port	integer	Nomor port protokol TCP, UDP, SMTP, atau POP3.	80
ping_num	integer	Jumlah hop untuk protokol PING.	20
authentication	integer	Menunjukkan apakah fitur otentikasi keamanan diaktifkan. Nilai yang valid: 0: Fitur diaktifkan. 1: Fitur dinonaktifkan.	1
http_method	string	Metode permintaan HTTP. Nilai yang valid: get post head	get
match_rule	integer	Menunjukkan apakah aturan peringatan disertakan. Nilai yang valid: 0: Aturan peringatan disertakan. 1: Aturan peringatan tidak disertakan.	0
dns_match_rule	string	Hubungan antara daftar alias atau alamat IP yang diharapkan dan daftar hasil DNS. Nilai yang valid: IN_DNS: Daftar nilai yang diharapkan adalah subset dari daftar hasil DNS. DNS_IN: Daftar hasil DNS adalah 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.	IN_DNS
request_content	string	Konten permintaan HTTP.	cf0f85
username	string	Nama pengguna protokol FTP, SMTP, atau POP3.	testUser
response_format	string	Format respons HTTP. Nilai yang valid: hex: heksadesimal txt: teks	hex
dns_type	string	Jenis catatan DNS. Parameter ini hanya dikembalikan jika parameter TaskType disetel ke DNS. Nilai yang valid: A (default): catatan yang menentukan alamat IP yang 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 nama host atau nama domain. Teks harus memiliki panjang 1 hingga 512 byte. Catatan TXT berfungsi sebagai catatan Sender Policy Framework (SPF) untuk melawan spam. AAAA: catatan yang memetakan nama domain ke alamat IPv6 yang relevan.	A
dns_server	string	Nama domain atau alamat IP server DNS.	192.168.XX.XX
enable_operator_dns	boolean	Menunjukkan apakah server DNS operator digunakan. true (default): Server DNS operator digunakan. false: Server DNS operator tidak digunakan. Server DNS default atau server DNS yang ditentukan digunakan.	true
attempts	integer	Jumlah percobaan ulang setelah terjadi kegagalan DNS.	3
protocol	string	Jenis protokol deteksi DNS. Nilai yang valid: udp (default) tcp tcp-tls	udp
proxy_protocol	boolean	Menunjukkan apakah protokol PROXY diaktifkan. Nilai yang valid: false (default): Protokol PROXY dinonaktifkan. true: Protokol PROXY diaktifkan.	false
acceptable_response_code	string	Kode status yang dapat diterima. Catatan Kami merekomendasikan Anda untuk mengonfigurasi assertion.	400
isBase64Encode	string	Menunjukkan apakah kata sandi didekode menggunakan algoritma Base64. Nilai yang valid: true: Kata sandi didekode menggunakan algoritma Base64. false (default): Kata sandi tidak didekode menggunakan algoritma Base64.	false
cert_verify	boolean	Menunjukkan apakah sertifikat diverifikasi. Nilai yang valid: false (default): Sertifikat tidak diverifikasi. true: Sertifikat diverifikasi.	false
unfollow_redirect	boolean	Menunjukkan apakah redirect diikuti jika kode status 301 atau 302 dikembalikan. Nilai yang valid: true: Redirect tidak diikuti. false (default): Redirect diikuti.	false
diagnosis_mtr	boolean	Menunjukkan apakah MTR secara otomatis digunakan untuk mendiagnosis masalah jaringan jika tugas gagal. Nilai yang valid: false (default): MTR tidak secara otomatis digunakan untuk mendiagnosis masalah jaringan jika tugas gagal. true: MTR secara otomatis digunakan untuk mendiagnosis masalah jaringan jika tugas gagal.	false
diagnosis_ping	boolean	Menunjukkan apakah permintaan ping secara otomatis dikirim untuk mendeteksi latensi jaringan jika tugas deteksi gagal. Nilai yang valid: false (default): Permintaan ping tidak secara otomatis dikirim untuk mendeteksi latensi jaringan jika tugas deteksi gagal. true: Permintaan ping secara otomatis dikirim untuk mendeteksi latensi jaringan jika tugas deteksi gagal.	false
retry_delay	integer	Jumlah percobaan ulang permintaan deteksi yang gagal.	1
assertions	object
assertions	array<object>	Assertion.
	object
property	string	Jalur parsing assertion. Jika jenis assertion adalah `body_json`, jalurnya adalah `json path`. Jika jenis assertion adalah `body_xml`, jalurnya adalah `xml path`.	json path
type	string	Jenis assertion. Nilai yang valid: response_time: memeriksa apakah waktu respons memenuhi ekspektasi. status_code: memeriksa apakah kode status HTTP memenuhi ekspektasi. header: memeriksa apakah field dalam header respons memenuhi ekspektasi. body_text: memeriksa apakah konten dalam body respons memenuhi ekspektasi menggunakan pencocokan teks. body_json: memeriksa apakah konten dalam body respons memenuhi ekspektasi menggunakan parsing JSON (JSONPath). body_xml: memeriksa apakah konten dalam body respons memenuhi ekspektasi menggunakan parsing XML (XPath).	response_time
operator	string	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 besar dari	lessThan
target	string	Nilai numerik atau karakter yang digunakan untuk pencocokan.	1000
AgentGroup	string	Jenis titik deteksi. Nilai yang valid: PC MOBILE	PC

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "New monitoring task",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "json path",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	%s	%s
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.