DescribeSiteMonitorAttribute - - Alibaba Cloud Documentation Center

Mengkueri detail tugas Pemantauan situs.

Topik ini memberikan contoh cara mengkueri detail tugas Pemantauan situs dengan ID cc641dff-c19d-45f3-ad0a-818a0c4f****. Hasil yang dikembalikan menunjukkan bahwa nama tugas adalah test123, alamat yang dipantau oleh tugas tersebut adalah https://aliyun.com, dan nama penyedia layanan adalah Alibaba.

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	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeSiteMonitorAttribute	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeSiteMonitorAttribute.
TaskId	String	Ya	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID tugas Pemantauan situs.
IncludeAlert	Boolean	Tidak	false	Menentukan apakah akan mengembalikan informasi aturan peringatan yang dikonfigurasi untuk tugas Pemantauan situs. Nilai yang valid: true: Sistem mengembalikan informasi aturan peringatan yang dikonfigurasi untuk tugas Pemantauan situs. false: Sistem tidak mengembalikan informasi aturan peringatan yang dikonfigurasi untuk tugas Pemantauan situs. Nilai default: false.

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

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
RequestId	String	D17DF650-7EBD-54D0-903A-1D4E624D7402	ID permintaan.
Code	String	200	Kode status HTTP. Catatan Kode status 200 menunjukkan bahwa pemanggilan berhasil.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. Nilai yang valid: true: Pemanggilan berhasil. false: Pemanggilan gagal.
SiteMonitors	Struct		Detail tugas Pemantauan situs.
Address	String	https://aliyun.com	Alamat yang dipantau oleh tugas Pemantauan situs.
Interval	String	1	Interval eksekusi tugas Pemantauan situs. Satuan: menit. Nilai yang valid: 1, 5, 15, 30, dan 60.
IspCities	Array of IspCity		Informasi titik deteksi. Informasi ini mencakup penyedia layanan yang menyediakan titik deteksi dan kota tempat titik deteksi berada.
IspCity
City	String	738	ID kota.
CityName	String	Beijing	Nama kota.
Isp	String	465	ID penyedia layanan.
IspName	String	Alibaba	Nama penyedia layanan.
OptionJson	Struct		Opsi tambahan tugas Pemantauan situs. Opsi ini bervariasi tergantung protokol yang ditentukan. Untuk informasi selengkapnya, lihat CreateSiteMonitor.
attempts	Long	3	Jumlah percobaan ulang setelah terjadi kegagalan DNS.
authentication	Integer	1	Menunjukkan apakah fitur otentikasi keamanan diaktifkan. Nilai yang valid: 0: Fitur otentikasi keamanan dinonaktifkan. 1: Fitur otentikasi keamanan diaktifkan.
cookie	String	lang=en	Cookie permintaan HTTP.
dns_match_rule	String	IN_DNS	Hubungan antara daftar alias atau alamat IP yang diharapkan dan 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.
dns_server	String	192.168.XX.XX	Alamat IP Server DNS. Catatan Parameter ini hanya dikembalikan jika parameter TaskType diatur ke DNS.
dns_type	String	A	Tipe Rekaman DNS. Parameter ini hanya dikembalikan jika parameter TaskType diatur ke DNS. Nilai yang valid: A: Nama default. Nilai ini menunjukkan catatan yang menentukan alamat IP terkait 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. Rekaman TXT berfungsi sebagai catatan Sender Policy Framework (SPF) untuk melawan spam.
expect_value	String	dns_server	Nama domain atau alias yang akan diurai. Catatan Parameter ini hanya dikembalikan jika parameter TaskType diatur ke DNS.
failure_rate	Float	0.4	Tingkat kehilangan paket. Catatan Parameter ini hanya dikembalikan jika parameter TaskType diatur ke PING.
header	String	testKey:testValue	Header permintaan HTTP.
http_method	String	get	Metode permintaan HTTP. Nilai yang valid: get post head
isBase64Encode	String	true	Menunjukkan apakah nilai parameter `password` dikodekan dalam Base64. true: Nilai parameter password dikodekan dalam Base64. false: Nilai parameter password tidak dikodekan dalam Base64.
match_rule	Integer	1	Menunjukkan apakah aturan peringatan disertakan. Nilai yang valid: 0: Aturan peringatan disertakan. 1: Aturan peringatan tidak disertakan.
password	String	123****	Password protokol SMTP, POP3, atau FTP.
ping_num	Integer	29	Heartbeat protokol PING.
port	Integer	110	Nomor Port protokol TCP, UDP, SMTP, atau POP3.
protocol	String	TCP	Protokol yang digunakan untuk mengirim permintaan.
request_content	String	aa=bb	Konten permintaan HTTP.
request_format	String	txt	Format permintaan HTTP. Nilai yang valid: hex: heksadesimal txt: teks
response_content	String	txt	Tanggapan terhadap permintaan HTTP.
response_format	String	txt	Format tanggapan. Nilai yang valid: hex: heksadesimal txt: teks
time_out	Long	3	Periode timeout. Satuan: milidetik.
username	String	testUser	Username protokol FTP, SMTP, atau POP3.
TaskId	String	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID tugas Pemantauan situs.
TaskName	String	test123	Nama tugas Pemantauan situs.
TaskState	String	1	Status tugas Pemantauan situs. Nilai yang valid: 1: Tugas diaktifkan. 2: Tugas dinonaktifkan.
TaskType	String	HTTP	Protokol yang digunakan oleh tugas Pemantauan situs. Nilai yang valid: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, dan FTP.
MetricRules	Array of MetricRule		Informasi aturan peringatan yang dikonfigurasi untuk tugas Pemantauan situs.
MetricRule
ActionEnable	String	true	Menunjukkan apakah aturan peringatan diaktifkan. Nilai yang valid: true: Aturan peringatan diaktifkan. false: Aturan peringatan dinonaktifkan.
AlarmActions	String	CloudMonitor	Kelompok kontak peringatan yang menerima Pemberitahuan peringatan.
ComparisonOperator	String	GreaterThanYesterday	Operator perbandingan yang digunakan dalam aturan peringatan. Nilai yang valid: `>=` `>` `<=` `<` `=` `!=` GreaterThanYesterday: lebih besar daripada nilai metrik pada waktu yang sama kemarin LessThanYesterday: lebih kecil daripada nilai metrik pada waktu yang sama kemarin GreaterThanLastWeek: lebih besar daripada nilai metrik pada waktu yang sama minggu lalu LessThanLastWeek: lebih kecil daripada nilai metrik pada waktu yang sama minggu lalu GreaterThanLastPeriod: lebih besar daripada nilai metrik dalam siklus pemantauan terakhir LessThanLastPeriod: lebih kecil daripada nilai metrik dalam siklus pemantauan terakhir
Dimensions	String	[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]	Dimensi aturan peringatan.
EvaluationCount	String	3	Jumlah kali berturut-turut nilai metrik diukur sebelum peringatan dipicu.
Expression	String	$Availability=30	Ekspresi yang digunakan untuk memicu peringatan.
Level	String	2	Tingkat keparahan peringatan. Nilai yang valid: 1: kritis 2: peringatan 3: informasi
MetricName	String	Availability	Nama metrik.
Namespace	String	acs_networkmonitor	Namespace layanan cloud.
OkActions	String	[ "CloudMonitor"]	Kelompok kontak peringatan yang menerima Pemberitahuan peringatan.
Period	String	15s	Interval pengkuerian data pemantauan. Nilainya sama dengan interval pelaporan data metrik. Satuan: detik. Catatan Jika Anda menentukan periode statistik untuk aturan peringatan, data mentah dikueri berdasarkan periode statistik tersebut.
RuleId	String	bf071ae_7b7aec3817b0fdf****	ID aturan peringatan.
RuleName	String	rule1	Nama aturan peringatan.
StateValue	String	OK	Status peringatan. Nilai yang valid: OK: normal. ALARM: Peringatan dipicu.
Statistics	String	Availability	Metode statistik aturan peringatan. Nilai yang valid: Availability: persentase titik deteksi yang tersedia AvailableNumber: jumlah titik deteksi yang tersedia ErrorCodeMaximum: kode status untuk peringatan ErrorCodeMinimum: semua kode status untuk serangkaian peringatan Average: waktu respons
Threshold	String	30	Ambang batas peringatan.
Message	String	successful	Pesan yang dikembalikan.

Contoh

Permintaan contoh

http(s)://[Endpoint]/?Action=DescribeSiteMonitorAttribute
&TaskId=cc641dff-c19d-45f3-ad0a-818a0c4f****
&<Common request parameters>

Respons sukses contoh

XML format

<DescribeSiteMonitorAttributeResponse>
	  <MetricRules>
		    <MetricRule>
			      <ComparisonOperator>GreaterThanYesterday</ComparisonOperator>
			      <RuleId>bf071ae_7b7aec3817b0fdf****</RuleId>
			      <Period>15s</Period>
			      <EvaluationCount>3</EvaluationCount>
			      <Dimensions>
				        <taskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</taskId>
			      </Dimensions>
			      <Statistics>Availability</Statistics>
			      <Namespace>acs_networkmonitor</Namespace>
			      <AlarmActions>CloudMonitor</AlarmActions>
			      <MetricName>Availability</MetricName>
			      <OkActions>CloudMonitor</OkActions>
			      <Expression>$Availability=30</Expression>
			      <ActionEnable>true</ActionEnable>
			      <StateValue>OK</StateValue>
			      <Level>2</Level>
			      <RuleName>rule1</RuleName>
			      <Threshold>30</Threshold>
		    </MetricRule>
	  </MetricRules>
	  <Message>successful</Message>
	  <RequestId>D17DF650-7EBD-54D0-903A-1D4E624D7402</RequestId>
	  <Code>200</Code>
	  <Success>true</Success>
	  <SiteMonitors>
		    <OptionJson>
			      <time_out>30000</time_out>
			      <http_method>get</http_method>
		    </OptionJson>
		    <TaskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</TaskId>
		    <Address>https://aliyun.com</Address>
		    <TaskName>test123</TaskName>
		    <TaskType>HTTP</TaskType>
		    <IspCities>
			      <IspCity>
				        <IspName>Alibaba</IspName>
				        <Isp>465</Isp>
				        <CityName>Beijing</CityName>
				        <City>738</City>
			      </IspCity>
		    </IspCities>
		    <TaskState>1</TaskState>
		    <Interval>1</Interval>
	  </SiteMonitors>
</DescribeSiteMonitorAttributeResponse>

JSON format

{
    "MetricRules": {
        "MetricRule": [
            {
                "ComparisonOperator": "GreaterThanYesterday",
                "RuleId": "bf071ae_7b7aec3817b0fdf****",
                "Period": "15s",
                "EvaluationCount": 3,
                "Dimensions": [
                    {
                        "taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****"
                    }
                ],
                "Statistics": "Availability",
                "Namespace": "acs_networkmonitor",
                "AlarmActions": [
                    "CloudMonitor"
                ],
                "MetricName": "Availability",
                "OkActions": [
                    "CloudMonitor"
                ],
                "Expression": "$Availability=30",
                "ActionEnable": true,
                "StateValue": "OK",
                "Level": 2,
                "RuleName": "rule1",
                "Threshold": "30"
            }
        ]
    },
    "Message": "successful",
    "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
    "Code": "200",
    "Success": true,
    "SiteMonitors": {
        "OptionJson": {
            "time_out": 30000,
            "http_method": "get"
        },
        "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
        "Address": "https://aliyun.com",
        "TaskName": "test123",
        "TaskType": "HTTP",
        "IspCities": {
            "IspCity": [
                {
                    "IspName": "Alibaba",
                    "Isp": "465",
                    "CityName": "Beijing",
                    "City": "738"
                }
            ]
        },
        "TaskState": 1,
        "Interval": 1
    }
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.