Gunakan CreateSiteMonitor untuk membuat tugas pemantauan situs - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Membuat tugas pemantauan situs.

Deskripsi operasi

Topik ini menjelaskan cara membuat tugas pemantauan situs. Contoh ini membuat tugas bernama HanZhou_ECS1 untuk memantau URL https://www.aliyun.com melalui HTTPS.

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

create

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Address	string	Yes	URL atau alamat IP yang akan dipantau.	https://www.aliyun.com
TaskType	string	Yes	Jenis tugas pemantauan. Protokol yang valid mencakup HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, FTP, dan WEBSOCKET.	HTTP
TaskName	string	Yes	Nama tugas pemantauan. Nama harus terdiri dari 4 hingga 100 karakter dan dapat berisi huruf, angka, garis bawah (_), dan karakter Tionghoa.	HanZhou_ECS1
Interval	string	No	Frekuensi pemantauan dalam menit. Nilai yang valid: 1, 5, 15, 30, dan 60. Default: 1.	1
IspCities	string	No	Titik deteksi. Jika Anda tidak menentukan parameter ini, sistem secara acak memilih tiga titik deteksi dari Internet Service Provider (ISP) yang berbeda. Nilai harus berupa array JSON. Contoh: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. Nilai-nilai tersebut sesuai dengan Beijing, Hangzhou, dan Qingdao. Untuk informasi lebih lanjut, lihat DescribeSiteMonitorISPCityList.	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	No	Opsi lanjutan untuk protokol yang ditentukan. Opsi yang tersedia bervariasi tergantung pada jenis protokol.	{"time_out":5000}
AlertIds	string	No	ID aturan peringatan. Untuk informasi lebih lanjut, lihat DescribeMetricRuleList.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
AgentGroup	string	No	Grup titik deteksi untuk tugas penyelidikan jaringan. `PC` menunjukkan titik deteksi di PC. `MOBILE` menunjukkan titik deteksi di perangkat seluler. `FC` menunjukkan titik deteksi di VPC. Nilai default-nya adalah `PC`.	PC
CustomSchedule	string	No	Jadwal deteksi khusus. Tentukan periode waktu dan hari-hari dalam seminggu untuk deteksi.	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfig	string	No	Informasi jaringan yang diperlukan untuk membuat tugas penyelidikan jaringan di VPC. Ini harus berupa objek JSON yang berisi kolom `vpcId`, `vswitchId`, `securityGroupId`, dan `region`.	{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

Tabel berikut menjelaskan parameter lanjutan untuk jenis tugas HTTP(S), PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3, dan FTP.

HTTP(S)

Parameter	Tipe	Deskripsi
http_method	String	Metode permintaan HTTP atau HTTPS. Nilai yang valid: GET, POST, dan HEAD. Default: GET.
header	String	Header HTTP kustom. Pisahkan beberapa header dengan umpan baris (\n). Setiap header harus dalam format `key:value` dan mengikuti protokol HTTP.
cookie	String	Cookie, diformat sebagai cookie permintaan HTTP standar.
request_content	String	Konten permintaan, dalam format JSON atau form. Jika Anda tidak menentukan parameter ini, body permintaan kosong.
response_content	String	Konten respons yang diharapkan. Sistem memeriksa 64 byte pertama dari respons server.
match_rule	String	0: Penyelidikan berhasil jika respons tidak berisi nilai response_content. 1: Penyelidikan berhasil jika respons berisi nilai response_content.
username	String	Nama pengguna untuk autentikasi Basic. Jika ditentukan, header `BasicAuth` disertakan dalam permintaan HTTP.
password	String	Kata sandi untuk autentikasi Basic.
time_out	int	Periode batas waktu dalam milidetik. Default: 5000.
max_redirect	int	Jumlah maksimum pengalihan. Default: 5 untuk titik deteksi ECS dan 2 untuk titik deteksi operator. Atur ke 0 untuk menonaktifkan pengalihan. Nilai yang valid: 0 hingga 50.

PING

Parameter	Tipe	Deskripsi
failure_rate	Text	Ambang batas tingkat kegagalan. Jika tingkat kegagalan ping melebihi nilai ini, penyelidikan gagal dan mengembalikan kode kesalahan 610 (PingAllFail) atau 615 (PingPartialFail). Default: 0.1.
ping_num	int	Jumlah paket ping yang akan dikirim. Default: 10. Nilai yang valid: 1 hingga 100.

Parameter	Tipe	Deskripsi
dns_server	string	Alamat server DNS. Ini dapat berupa nama domain atau alamat IP.
dns_type	string	Jenis kueri DNS. Nilai yang valid: A, NS, CNAME, MX, TXT, ANY, dan AAAA.
expect_value	string	Daftar nilai yang diharapkan, dipisahkan dengan spasi.
match_rule	string	Aturan pencocokan antara nilai yang diharapkan dan hasil kueri DNS. Penyelidikan gagal jika aturan ini tidak terpenuhi. `IN_DNS `atau string kosong: Nilai yang diharapkan harus merupakan subset dari hasil DNS.<br>\`DNS_IN`: Hasil DNS harus merupakan subset dari nilai yang diharapkan.<br>\`EQUAL`: Hasil DNS harus identik dengan nilai yang diharapkan.<br>\`ANY`: Hasil DNS dan nilai yang diharapkan harus memiliki setidaknya satu nilai yang sama.

Parameter	Tipe	Deskripsi
port	int	Port server FTP. Default: 21 untuk FTP dan 990 untuk FTPS.
username	string	Nama pengguna untuk login FTP. Jika tidak ditentukan, login anonim akan digunakan.
password	string	Kata sandi untuk login FTP.

POP3 atau SMTP

Parameter	Tipe	Deskripsi
port	int	Port server. Default: 110 untuk POP3, 995 untuk POP3S, dan 25 untuk SMTP.
username	string	Nama pengguna untuk login POP3 atau SMTP. Baik nama pengguna maupun kata sandi diperlukan.
password	string	Kata sandi untuk login POP3 atau SMTP. Baik nama pengguna maupun kata sandi diperlukan.

TCP atau UDP

Parameter	Tipe	Deskripsi
port	int	Port server TCP atau UDP.
request_content	string	Konten permintaan. Jika `request_format` adalah `hex`, nilai ini harus dalam format heksadesimal yang kompak.
request_format	string	Format konten permintaan. Jika ini bukan `hex`, `request_content` dikirim sebagai string biasa.
response_content	string	Konten respons yang diharapkan. Penyelidikan gagal jika respons server tidak berisi nilai ini. Jika `request_format` adalah `hex`, nilai ini harus dalam format heksadesimal yang kompak. Jika tidak, ini diperlakukan sebagai string biasa.

WEBSOCKET

Parameter	Tipe	Deskripsi
request_content	string	Konten pesan yang akan dikirim.
empty_message	boolean	Menentukan apakah pesan kosong atau tidak ada pesan dari server dianggap sebagai keberhasilan.

Elemen respons

Element	Type	Description	Example
	object	N/A.
Code	string	Kode status operasi. Catatan Nilai `200` menunjukkan keberhasilan.	200
Message	string	Pesan yang dikembalikan untuk permintaan.	Successful
RequestId	string	ID permintaan.	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
Data	object	T/A.
AttachAlertResult	object
Contact	array<object>	The results of associating the alert rules.
	object	The result for a single alert rule association.
Code	string	The status code for the association operation. Catatan A value of `200` indicates success.	200
Message	string	The message returned for the association operation.	successful
RequestId	string	The request ID for the association operation.	5dd33455-4f65-4b0c-9200-33d66f3f340b
Success	string	Indicates whether the alert rule was successfully associated. Valid values: true: The association was successful. false: The association failed.	true
RuleId	string	The ID of the alert rule.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CreateResultList	object
CreateResultList	array<object>	Daftar hasil untuk setiap tugas yang dibuat. Ini hanya dikembalikan jika pembuatan tugas berhasil.
	object	Hasil untuk satu tugas yang dibuat. Ini hanya dikembalikan jika pembuatan tugas berhasil.
TaskId	string	The ID of the created monitoring task.	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	The name of the created monitoring task.	HanZhou_ECS1

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidQueryParameter	%s
400	IllegalAddress	Illegal HTTP address
400	OperationError	Operation failed
400	TaskNotExists	Task does not exist
400	OperatorInvalid	Operator invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	OperatorCityInvalid	Invalid Isp.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	%s
403	RestrictedUser	The user's operation is restricted, please register NAAM product code
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.
409	%s	%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.