Queries site monitoring tasks.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeSiteMonitorList |
The operation that you want to perform. Set the value to DescribeSiteMonitorList. |
Keyword | String | No | site |
The keyword used to query site monitoring tasks. Fuzzy search is supported for task names or monitored addresses. |
Page | Integer | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. |
TaskId | String | No | a1ecd34a-8157-44d9-b060-14950837**** |
The ID of the site monitoring task. |
TaskType | String | No | HTTP |
The protocol used by the site monitoring task. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | 200 |
The HTTP status code. The status code 200 indicates that the call was successful. |
Message | String | Successfully |
The returned message. |
PageNumber | Integer | 1 |
The number of the returned page. |
PageSize | Integer | 10 |
The number of entries returned on each page. Default value: 10. |
RequestId | String | 68192f5d-0d45-4b98-9724-892813f86c71 |
The ID of the request. |
SiteMonitors |
The site monitoring tasks that were found. |
||
Address | String | http://www.aliyun.com |
The URL or IP address monitored by the site monitoring task. |
CreateTime | String | 2019-03-02 09:02:51 |
The time when the site monitoring task was created. |
Interval | String | 1 |
The interval at which detection requests are sent to the monitored address. Unit: minutes. |
OptionsJson | Json | {"time_out":5000} |
The extended options of the protocol used by the site monitoring task. The options vary based on the protocol. |
TaskId | String | a1ecd34a-8127-44d9-b060-14950837**** |
The ID of the site monitoring task. |
TaskName | String | Alibaba Cloud official website monitoring |
The name of the site monitoring task. |
TaskState | String | 1 |
Indicates whether the site monitoring task was enabled. The value 1 indicates that the site monitoring task was enabled. The value 2 indicates that the site monitoring task was disabled. |
TaskType | String | HTTP |
The protocol used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP. |
UpdateTime | String | 2019-03-03 14:16:34 |
The time when the site monitoring task was updated. |
Success | String | true |
Indicates whether the call was successful. |
TotalCount | Integer | 10 |
The total number of entries returned. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeSiteMonitorList
&<Common request parameters>
Sample success responses
XML
format
<DescribeSiteMonitorListResponse>
<Message>Successfully</Message>
<RequestId>95078877-009D-43C2-8654-67AE771C08D9</RequestId>
<SiteMonitors>
<SiteMonitor>
<Interval>1</Interval>
<CreateTime>2019-03-02 09:02:51</CreateTime>
<Address>http://www.aliyun.com</Address>
<OptionsJson>
<http_method>get</http_method>
<time_out>30000</time_out>
</OptionsJson>
<UpdateTime>2019-03-03 15:48:00</UpdateTime>
<TaskId>49f7b317-7645-4cc9-94fd-12****</TaskId>
<TaskName>Alibaba Cloud official website monitoring</TaskName>
<TaskState>2</TaskState>
<TaskType>HTTP</TaskType>
</SiteMonitor>
</SiteMonitors>
<Success>true</Success>
<Code>200</Code>
</DescribeSiteMonitorListResponse>
JSON
format
{
"Message":"Successfully",
"RequestId":"95078877-009D-43C2-8654-67AE771C08D9",
"Success":true,
"SiteMonitors":{
"SiteMonitor":[
{
"Interval":1,
"Address":"http://www.aliyun.com",
"CreateTime":"2019-03-02 09:02:51",
"OptionsJson":{
"http_method":"get",
"time_out":30000
},
"UpdateTime":"2019-03-03 15:48:00",
"TaskId":"49f7b317-7645-4cc9-94fd-12****",
"TaskType":"HTTP",
"TaskState":2,
"TaskName":"Alibaba Cloud official website monitoring"
}
]
},
"Code":"200"
}
Error codes
For a list of error codes, visit the API Error Center.