调用DescribeSiteMonitorList接口查询站点监控任务列表。

本文将提供一个示例,查询当前账号的站点监控任务列表。返回结果显示当前账号存在一条站点监控记录HanZhou_ECS2

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSiteMonitorList

要执行的操作,取值:DescribeSiteMonitorList。

TaskId String a1ecd34a-8157-44d9-b060-14950837****

站点监控任务ID。

TaskType String HTTP

站点监控任务探测类型。云监控支持的探测类型包括:HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。

Keyword String site

查询站点监控任务的关键字。

说明 支持根据任务名称或任务地址模糊搜索。
Page Integer 1

分页页码。默认值:1。

PageSize Integer 10

每页显示条数。默认值:10。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String successful

返回信息。

PageNumber Integer 1

分页页码。

PageSize Integer 10

每页显示记录条数。

RequestId String 68192f5d-0d45-4b98-9724-892813f86c71

请求ID。

SiteMonitors Array of SiteMonitor

站点监控任务列表。

SiteMonitor
Address String https://aliyun.com

任务的探测URL地址或IP地址。

CreateTime String 2020-11-04 15:23:09

任务的创建时间。

Interval String 1

探测频率。单位:分钟。

OptionsJson Struct

扩展选项。每一种探测类型有不同的扩展类型,详情请参见CreateSiteMonitor

authentication Integer 1

是否开启安全验证。取值:

  • 0:否。
  • 1:是。
cookie String lang=en

发送HTTP请求的Cookie。

dns_server String 8.8.8.8

DNS服务器的IP地址。

说明 仅适用于DNS探测类型。
dns_type String A

DNS解析类型。仅适用于DNS探测类型。取值:

  • A(默认值):指定主机名或域名对应的IP地址。
  • CNAME:将多个域名映射到另外一个域名。
  • NS:指定域名由某个DNS服务器解析。
  • MX:将域名指向一个邮件服务器地址。
  • TXT:主机名或域名的说明。文本长度限制512字节,通常用做SPF(Sender Policy Framework)记录,即反垃圾邮件。
failure_rate Float 0.5

丢包率。

说明 该参数仅适用于PING探测类型。
header String testKey:testValue

HTTP请求头。

http_method String get

HTTP请求方法。取值:

  • get
  • post
  • head
match_rule Integer 0

是否包含报警规则。取值:

  • 0:是。
  • 1:否。
password String 123****

SMTP/POP3/FTP探测类型的密码。

ping_num Integer 20

PING探测的跳数设置。

port Integer 8080

TCP、UDP、SMTP、POP3探测类型的端口。

request_content String aa=bb

HTTP探测请求内容。

request_format String txt

HTTP请求内容格式。取值:

  • hex:十六进制格式。
  • txt:文本格式。
response_content String user

匹配响应内容。

response_format String txt

HTTP响应内容格式。取值:

  • hex:十六进制格式。
  • txt:文本格式。
time_out Long 5000

超时时间。单位:毫秒。

username String testUser

FTP、SMTP或POP3的用户名。

TaskId String a1ecd34a-8127-44d9-b060-14950837****

站点监控任务ID。

TaskName String 新的探测任务

站点监控任务名称。

TaskState String 1

任务状态。取值:

  • 1:正常。
  • 2:禁用。
TaskType String HTTP

站点监控任务探测类型。云监控支持的探测类型包括:HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。

UpdateTime String 2019-03-03 14:16:34

站点监控任务更新时间。

Success String true

操作是否成功。取值:

  • true:成功。
  • false:失败。
TotalCount Integer 10

总记录条数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSiteMonitorList
&<公共请求参数>

正常返回示例

XML格式

<DescribeSiteMonitorListResponse>
	  <TotalCount>4</TotalCount>
	  <Message>successful</Message>
	  <RequestId>C60B8269-9B1C-4C32-8BCC-947D03B09274</RequestId>
	  <PageSize>10</PageSize>
	  <PageNumber>1</PageNumber>
	  <Code>200</Code>
	  <Success>true</Success>
	  <SiteMonitors>
		    <SiteMonitor>
			      <TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>
			      <Address>https://www.aliyun.com</Address>
			      <TaskName>HanZhou_ECS2</TaskName>
			      <OptionsJson>
				        <http_method>get</http_method>
				        <time_out>30000</time_out>
			      </OptionsJson>
			      <TaskType>HTTP</TaskType>
			      <CreateTime>2020-11-06 10:20:09</CreateTime>
			      <UpdateTime>2020-11-06 13:44:40</UpdateTime>
			      <TaskState>1</TaskState>
			      <Interval>1</Interval>
		    </SiteMonitor>
	  </SiteMonitors>
</DescribeSiteMonitorListResponse>

JSON格式

{
	"TotalCount": 4,
	"Message": "successful",
	"RequestId": "C60B8269-9B1C-4C32-8BCC-947D03B09274",
	"PageSize": 10,
	"PageNumber": 1,
	"Code": "200",
	"Success": true,
	"SiteMonitors": {
		"SiteMonitor": [
			{
				"TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
				"Address": "https://www.aliyun.com",
				"TaskName": "HanZhou_ECS2",
				"OptionsJson": {
					"http_method": "get",
					"time_out": 30000
				},
				"TaskType": "HTTP",
				"CreateTime": "2020-11-06 10:20:09",
				"UpdateTime": "2020-11-06 13:44:40",
				"TaskState": 1,
				"Interval": 1
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。