调用DescribeSiteMonitorAttribute接口查询站点监控任务的详细信息。

本文将提供一个示例,查询站点监控任务6eafb10e-e0b6-41b3-98ea-89131c12****的详细信息,返回结果显示站点监控任务的名称test123、探测地址https://aliyun.com、运营商阿里巴巴等信息。

调试

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

请求参数

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

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

TaskId String 6eafb10e-e0b6-41b3-98ea-89131c12****

监控任务ID。

IncludeAlert Boolean false

返回的任务详情是否包含报警规则。

  • true:如果该参数的取值为true,则返回报警规则。
  • false:如果该参数的取值为false,则不返回报警规则。

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

返回数据

名称 类型 示例值 描述
RequestId String 9ed350c5-d579-4ba1-9c5d-dda70cd8422c

请求ID。

Code String 200

状态码。

说明 200表示成功。
Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
SiteMonitors Struct

监控任务详情。

Address String https://aliyun.com

监控任务的探测地址。

Interval String 1

监控任务的频率。单位:分钟,取值:1、 5、15。

IspCities Array of IspCity

探测点的运营商和城市。

IspCity
City String 546

城市ID。

CityName String 杭州市

城市名称。

Isp String 465

运营商ID。

IspName String 阿里巴巴

运营商名称。

OptionJson Struct

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

authentication Integer 1

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

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

发送HTTP请求的Cookie。

dns_server String 192.168.XX.XX

DNS服务器的IP地址。

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

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

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

待解析的别名或地址。

说明 该参数仅适用于DNS探测类型。
failure_rate Float 0.4

丢包率。

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

HTTP请求头。

http_method String get

HTTP请求方法。取值:

  • get
  • post
  • head
match_rule Integer 1

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

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

SMTP、POP3或FTP探测类型的密码。

ping_num Integer 29

PING探测类型的心跳。

port Integer 110

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

request_content String aa=bb

HTTP探测类型的请求内容。

request_format String txt

HTTP请求内容格式。取值:

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

匹配响应内容。

response_format String txt

HTTP响应内容格式。取值:

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

超时时间。单位:毫秒。

username String testUser

FTP、SMTP或POP3的用户名。

TaskId String 6eafb10e-e0b6-41b3-98ea-89131c12****

监控任务ID。

TaskName String test123

监控任务名称。

TaskState String OK

报警规则状态。

TaskType String HTTP

监控任务类型。目前站点监控任务的类型包括:HTTP(s)、PING、TCP、UDP、DNS、SMTP、POP3、FTP。

MetricRules Array of MetricRule

监控任务的报警规则。

MetricRule
ActionEnable String true

报警规则的状态。

AlarmActions String ["通知联系人组"]

报警规则通知的报警联系人组。

ComparisonOperator String >

比较符。

Dimensions String [ { "taskId": "49f7b317-7645-4cc9-94fd-ea42e522****" } ]

报警规则对应的维度。

EvaluationCount String 3

报警重试次数。

Expression String $Availability>90

报警规则的表达式。

Level String 3

报警规则的级别。取值:

  • 1:紧急。
  • 2:警告。
  • 3:信息。
MetricName String Availability

监控项名称。

Namespace String acs_networkmonitor

云服务的数据命名空间,用于区分不同的云产品。

命名方式:acs_云服务名称。

OkActions String ["Alice"]

收到报警的联系人组。

Period String 60

时间间隔。通常是监控项的上报周期,单位:秒。

说明 如果您设置了统计周期,则会按照此周期查询对应的统计数据 。
RuleId String 49f7b317-7645-4cc1-94fd-ea42e522****

报警规则ID。

RuleName String ECS_test

报警规则名称。

StateValue String OK

报警的状态。取值:

  • OK:正常
  • ALARM:报警
Statistics String Availability

报警的统计方法。

Threshold String 90

报警的阈值。

Message String successful

返回信息。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSiteMonitorAttribute
&TaskId=6eafb10e-e0b6-41b3-98ea-89131c12****
&<公共请求参数>

正常返回示例

XML格式

<DescribeSiteMonitorAttributeResponse>
	  <Message>successful</Message>
	  <RequestId>DD7AED9A-06E2-49D7-9DEA-12DC32FBE34B</RequestId>
	  <Code>200</Code>
	  <Success>true</Success>
	  <SiteMonitors>
		    <OptionJson>
			      <time_out>30000</time_out>
			      <http_method>get</http_method>
			      <match_rule>0</match_rule>
		    </OptionJson>
		    <TaskId>6eafb10e-e0b6-41b3-98ea-89131c12****</TaskId>
		    <Address>https://aliyun.com</Address>
		    <TaskName>test123</TaskName>
		    <TaskType>HTTP</TaskType>
		    <IspCities>
			      <IspCity>
				        <IspName>阿里巴巴</IspName>
				        <Isp>465</Isp>
				        <CityName>上海市</CityName>
				        <City>357</City>
			      </IspCity>
			      <IspCity>
				        <IspName>阿里巴巴</IspName>
				        <Isp>465</Isp>
				        <CityName>深圳市</CityName>
				        <City>304</City>
			      </IspCity>
			      <IspCity>
				        <IspName>阿里巴巴</IspName>
				        <Isp>465</Isp>
				        <CityName>张家口市</CityName>
				        <City>503</City>
			      </IspCity>
		    </IspCities>
		    <TaskState>1</TaskState>
		    <Interval>1</Interval>
	  </SiteMonitors>
</DescribeSiteMonitorAttributeResponse>

JSON格式

{"MetricRules":{"MetricRule":[{"ComparisonOperator":">","RuleId":"49f7b317-7645-4cc1-94fd-ea42e522****","Dimensions":"[ {  \"taskId\": \"49f7b317-7645-4cc9-94fd-ea42e522****\" } ]","EvaluationCount":"3","Period":"60","Statistics":"Availability","Namespace":"acs_networkmonitor","AlarmActions":"[\"通知联系人组\"]","MetricName":"Availability","Expression":"$Availability>90","OkActions":"[\"Alice\"]","ActionEnable":"true","StateValue":"OK","Level":"3","RuleName":"ECS_test","Threshold":"90"}]},"RequestId":"9ed350c5-d579-4ba1-9c5d-dda70cd8422c","Message":"successful","Code":"200","Success":"true","SiteMonitors":{"TaskId":"6eafb10e-e0b6-41b3-98ea-89131c12****","Address":"https://aliyun.com","TaskName":"test123","TaskType":"HTTP","TaskState":"OK","Interval":"1","IspCities":{"IspCity":[{"IspName":"阿里巴巴","Isp":"465","City":"546","CityName":"杭州市"}]},"OptionJson":{"dns_type":"A","cookie":"lang=en","ping_num":"29","dns_server":"192.168.XX.XX","time_out":"3","expect_value":"dns_server","response_content":"txt","failure_rate":"0.4","password":"123****","response_format":"txt","request_format":"txt","http_method":"get","request_content":"aa=bb","port":"110","header":"testKey:testValue","match_rule":"1","authentication":"1","username":"testUser"}}}

错误码

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