文档

DescribeSiteMonitorAttribute - 查询站点监控任务的详细信息

更新时间:

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

接口说明

本文将提供一个示例,查询站点监控任务cc641dff-c19d-45f3-ad0a-818a0c4f****的详细信息,返回结果显示,站点监控任务的名称为test123、探测地址为https://aliyun.com、运营商为阿里巴巴等信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeSiteMonitorAttributeget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TaskIdstring

监控任务 ID。

cc641dff-c19d-45f3-ad0a-818a0c4f****
IncludeAlertboolean

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

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

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

返回参数

名称类型描述示例值
object

返回结果。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

successful
MetricRulesarray<object>

监控任务的报警规则。

MetricRuleobject

监控任务的报警规则。

ActionEnablestring

报警规则的状态。取值:

  • true:启用。
  • false:禁用。
true
AlarmActionsstring

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

CloudMonitor
ComparisonOperatorstring

报警规则的阈值比较符。取值:

  • >=
  • >
  • <=
  • <
  • =
  • !=
  • GreaterThanYesterday:同比昨天同时间上涨。
  • LessThanYesterday:同比昨天同时间下降。
  • GreaterThanLastWeek:同比上周同一时间上涨。
  • LessThanLastWeek:同比上周同一时间下降。
  • GreaterThanLastPeriod:环比上周期上涨。
  • LessThanLastPeriod:环比上周期下降。
GreaterThanYesterday
Dimensionsstring

报警规则对应的维度。

[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]
EvaluationCountstring

报警重试次数。

3
Expressionstring

报警规则的表达式。

$Availability=30
Levelstring

报警规则的级别。取值:

  • 1:紧急。

  • 2:警告。

  • 3:信息。

2
MetricNamestring

监控项名称。

Availability
Namespacestring

云服务的数据命名空间。

acs_networkmonitor
OkActionsstring

收到报警的联系人组。

[ "CloudMonitor"]
Periodstring

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

说明 如果您设置了统计周期,则会按照此周期查询对应的统计数据 。
15s
RuleIdstring

报警规则 ID。

bf071ae_7b7aec3817b0fdf****
RuleNamestring

报警规则名称。

rule1
StateValuestring

报警的状态。取值:

  • OK:正常。

  • ALARM:报警。

OK
Statisticsstring

报警的统计方法。取值:

  • Availability:可用探测点百分比。
  • AvailableNumber:可用探测点数量。
  • ErrorCodeMaximum:任意状态码(独立报警)。
  • ErrorCodeMinimum:所有状态码(组合报警)。
  • Average:响应时间。
Availability
Thresholdstring

报警阈值。

30
RequestIdstring

请求 ID。

D17DF650-7EBD-54D0-903A-1D4E624D7402
SiteMonitorsobject

监控任务详情。

Addressstring

监控任务的探测地址。

https://aliyun.com
AgentGroupstring

探测点类型。默认为 PC。 取值:

  • PC 固网

  • MOBILE 移动端

PC
CustomScheduleobject

自定义探测周期。只能选择周一至周日的某个时间段进行探测。

daysarray

探测日。

daysinteger

探测日。

1
end_hourinteger

自定义探测结束时间。

单位:小时。

18
start_hourinteger

自定义探测开始时间。

单位:小时。

8
time_zonestring

自定义探测的时区。

local
Intervalstring

监控任务的周期。单位:分钟。取值:1、 5、15、30 和 60。

1
IspCitiesarray<object>

探测点的运营商和城市。

IspCityobject

探测点的运营商和城市。

Citystring

城市 ID。

738
CityNamestring

城市名称。

北京市
Ispstring

运营商 ID。

465
IspNamestring

运营商名称。

阿里巴巴
Typestring

探测点网络类型。取值: IDC: IDC 机房 LASTMILE: 网民家宽 MOBILE: 移动蜂窝网

IDC
OptionJsonobject

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

assertionsarray<object>

断言配置组。

assertionsobject

断言配置组。

operatorstring

断言比较操作符。取值:

  • contains:包含。
  • doesNotContain:不包含。
  • matches:正则匹配。
  • doesNotMatch:正则不匹配。
  • is:数值等于或字符匹配相等。
  • isNot:不等于。
  • lessThan:小于。
  • moreThan:大于。
lessThan
propertystring

断言内容解析路径。

  • 如果断言类型为body_json,则路径为json path

  • 如果断言类型是body_xml,则路径为xml path

json path
targetstring

断言匹配比较的目标数值或字符。

0
typestring

断言类型。取值:

  • response_time:判定响应时间是否符合预期。
  • status_code:判断 HTTP 响应状态码是否符合预期。
  • header:判定响应 Header 中的字段是否符合预期。
  • body_text:通过文本字符匹配判断返回 Body 中的内容是否符合预期。
  • body_json:通过 JSON 解析(JSON Path)判断返回 Body 中的内容是否符合预期。
  • body_xml:通过 XML 解析(XPath)判断返回 Body 中的内容是否符合预期。
response_time
attemptslong

DNS 失败后重试次数。

3
authenticationinteger

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

  • 0:否。
  • 1:是。
1
blocked_url_listarray

屏蔽的资源 URL 列表。支持路径通配符。

blocked_url_liststring

屏蔽的资源 URL 列表。支持路径通配符。

www.taobao.com/**
browser_headersarray<object>

自定义 Header。结构为{"key": "somekey", "value":"somevalue"}

browser_headersobject

自定义 Header。结构为{"key": "somekey", "value":"somevalue"}

{"key":"value"}
browser_hostsarray

自定义 Host。结构为{"url":"someurl", "ip":"someip"}

browser_hostsstring

自定义 Host。结构为{"url":"someurl", "ip":"someip"}

{"url":"www.taobao.com","ip":"127.0.0.1"}
browser_infoarray<object>

浏览器信息。

browser_infoobject

浏览器信息。

browserstring

浏览器类型。

Chrome
devicestring

屏幕类型。

laptop
browser_insecureboolean

是否忽略证书错误。取值:

  • false:不忽略证书错误。
  • true:忽略证书错误。
false
browser_task_versionstring

浏览器拨测版本。取值:

  • 1:单页拨测。
  • 2:多页拨测。
1
cookiestring

发送 HTTP 请求的 Cookie。

lang=en
diagnosis_mtrboolean

是否开启任务失败后的自动 MTR 网络诊断。取值:

  • false:不开启自动 MTR 网络诊断。
  • true 开启自动 MTR 网络诊断。
false
diagnosis_pingboolean

是否开启任务失败后自动 PING 网络延时探测。取值:

  • false:不开启自动 PING 网络延时探测。
  • true:开启自动 PING 网络延时探测。
false
dns_hijack_whiteliststring

DNS 劫持配置列表。

www.taobao.com:www.taobao.com.danuoyi.tbcache.com
dns_match_rulestring

DNS 的匹配规则。取值:

  • IN_DNS:期望解析的别名或 IP 地址均在 DNS 应答中。
  • DNS_IN:所有的 DNS 应答都出现在期望解析的别名或 IP 地址中。
  • EQUAL:DNS 应答和期望解析的别名或 IP 地址完全相同。
  • ANY:DNS 应答和期望解析的别名或 IP 地址有交集。
IN_DNS
dns_serverstring

DNS 服务器的 IP 地址。

说明 仅适用于 DNS 探测类型。
192.168.XX.XX
dns_typestring

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

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

是否允许 WebSocket 任务不返回消息或返回空消息。取值:

  • false(默认):否。
  • true: 是。
false
expect_exist_stringarray

期待页面中存在的字符串列表。

expect_exist_stringstring

期待页面中存在的字符串列表。

expected string
expect_non_exist_stringarray

期待页面中不存在的字符串列表。

expect_non_exist_stringstring

期待页面中不存在的字符串列表。

unexpected string
expect_valuestring

待解析的别名或地址。

说明 该参数仅适用于 DNS 探测类型。
dns_server
failure_ratefloat

丢包率。

说明 该参数仅适用于 PING 探测类型。
0.4
headerstring

HTTP 请求头。

testKey:testValue
http_methodstring

HTTP 请求方法。取值:

  • get
  • post
  • head
get
ip_networkstring

ip_network 指示该任务的网络类型,可选值为 v4,v6,auto,默认值为 v4

v4
isBase64Encodestring

是否对密码进行 base64 解码存储。取值:

  • true:对密码进行 base64 解码存储。
  • false:不对密码进行 base64 解码存储。
false
match_ruleinteger

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

  • 0:是。
  • 1:否。
1
min_tls_versionstring

最低 TLS 版本。默认支持 TLS1.2 及以上版本,TLS1.0 和 1.1 已被禁用,如仍需支持可更改配置

tlsv1.2
passwordstring

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

123****
ping_numinteger

PING 探测类型的心跳。

29
ping_portinteger

PING 端口。适用于 TCP PING。

80
ping_typestring

PING 协议类型。取值:

  • icmp

  • tcp

  • udp

icmp
portinteger

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

110
protocolstring

探测协议。

TCP
quic_enabledboolean

浏览器拨测是否使用 quic 协议,取值: true,使用 quic 协议 false,不实用 quic 协议 默认值为 false

true
quic_targetarray

强制使用 quic 协议的站点列表

quic_targetstring

强制使用 quic 协议的站点,格式为 url:port,port 可以不填,默认为 443

www.taobao.com
request_contentstring

HTTP 探测类型的请求内容。

aa=bb
request_formatstring

HTTP 请求内容格式。取值:

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

匹配响应内容。

txt
response_formatstring

HTTP 响应内容格式。取值:

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

探测失败后重试次数。

0
screen_shotboolean

是否开启页面截图

false
time_outlong

超时时间。单位:毫秒。

3
traffic_hijack_element_blacklistarray

当发生重定向时,如果浏览器加载资源的 URL 与该列表中的表达能匹配,则认为发生流量劫持。

traffic_hijack_element_blackliststring

当发生重定向时,如果浏览器加载资源的 URL 与该列表中的表达能匹配,则认为发生流量劫持。

www.taobao.com
traffic_hijack_element_countinteger

当发生重定向时,如果浏览器加载资源数超过这个值,则认为发生流量劫持。当该值为 0 时,不进行校验,默认值为 0。

0
traffic_hijack_element_whitelistarray

当发生重定向时,如果浏览器加载资源的 URL 与该列表中的任意一个表达式都不匹配,则认为发生流量劫持。

traffic_hijack_element_whiteliststring

当发生重定向时,如果浏览器加载资源的 URL 与该列表中的任意一个表达式都不匹配,则认为发生流量劫持。

www.taobao.com
usernamestring

FTP、SMTP 或 POP3 的用户名。

testUser
waitTime_after_completioninteger

浏览器拨测任务中,页面打开后的额外等待时间。

3
TaskIdstring

监控任务 ID。

cc641dff-c19d-45f3-ad0a-818a0c4f****
TaskNamestring

监控任务名称。

test123
TaskStatestring

监控任务的状态。取值:

  • 1:启用。
  • 2:禁用。
1
TaskTypestring

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

HTTP
VpcConfigobject

内网拨测任务的 VPC 配置信息。

Regionstring

内网拨测任务的目标站点所在地域。

cn-beijing
SecurityGroupIdstring

该内网拨测任务受限于的安全组 id。

sg-xxxxxx
VpcIdstring

该内网拨测任务挂载的 vpc id。

vpc-xxxxxx
VswitchIdstring

该内网拨测任务挂载的 vswitch id。

vsw-xxxxxx
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "MetricRules": {
    "MetricRule": [
      {
        "ActionEnable": "true",
        "AlarmActions": "CloudMonitor",
        "ComparisonOperator": "GreaterThanYesterday",
        "Dimensions": "[{\"taskId\": \"cc641dff-c19d-45f3-ad0a-818a0c4f****\" }]",
        "EvaluationCount": "3",
        "Expression": "$Availability=30",
        "Level": "2",
        "MetricName": "Availability",
        "Namespace": "acs_networkmonitor",
        "OkActions": "[ \"CloudMonitor\"]",
        "Period": "15s",
        "RuleId": "bf071ae_7b7aec3817b0fdf****",
        "RuleName": "rule1",
        "StateValue": "OK",
        "Statistics": "Availability",
        "Threshold": "30"
      }
    ]
  },
  "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
  "SiteMonitors": {
    "Address": "https://aliyun.com",
    "AgentGroup": "PC",
    "CustomSchedule": {
      "days": {
        "days": [
          1
        ]
      },
      "end_hour": 18,
      "start_hour": 8,
      "time_zone": "local"
    },
    "Interval": "1",
    "IspCities": {
      "IspCity": [
        {
          "City": "738",
          "CityName": "北京市",
          "Isp": "465",
          "IspName": "阿里巴巴",
          "Type": "IDC"
        }
      ]
    },
    "OptionJson": {
      "assertions": {
        "assertions": [
          {
            "operator": "lessThan",
            "property": "json path",
            "target": "0",
            "type": "response_time"
          }
        ]
      },
      "attempts": 3,
      "authentication": 1,
      "blocked_url_list": {
        "blocked_url_list": [
          "www.taobao.com/**"
        ]
      },
      "browser_headers": {
        "browser_headers": [
          {
            "key": "value"
          }
        ]
      },
      "browser_hosts": {
        "browser_hosts": [
          "{\"url\":\"www.taobao.com\",\"ip\":\"127.0.0.1\"}"
        ]
      },
      "browser_info": {
        "browser_info": [
          {
            "browser": "Chrome",
            "device": "laptop"
          }
        ]
      },
      "browser_insecure": false,
      "browser_task_version": "1",
      "cookie": "lang=en",
      "diagnosis_mtr": false,
      "diagnosis_ping": false,
      "dns_hijack_whitelist": "www.taobao.com:www.taobao.com.danuoyi.tbcache.com",
      "dns_match_rule": "IN_DNS",
      "dns_server": "192.168.XX.XX",
      "dns_type": "A",
      "empty_message": false,
      "expect_exist_string": {
        "expect_exist_string": [
          "expected string"
        ]
      },
      "expect_non_exist_string": {
        "expect_non_exist_string": [
          "unexpected string"
        ]
      },
      "expect_value": "dns_server",
      "failure_rate": 0.4,
      "header": "testKey:testValue",
      "http_method": "get",
      "ip_network": "v4",
      "isBase64Encode": "false",
      "match_rule": 1,
      "min_tls_version": "tlsv1.2",
      "password": "123****",
      "ping_num": 29,
      "ping_port": 80,
      "ping_type": "icmp",
      "port": 110,
      "protocol": "TCP",
      "quic_enabled": true,
      "quic_target": {
        "quic_target": [
          "www.taobao.com"
        ]
      },
      "request_content": "aa=bb",
      "request_format": "txt",
      "response_content": "txt",
      "response_format": "txt",
      "retry_delay": 0,
      "screen_shot": false,
      "strict_mode": false,
      "time_out": 3,
      "traffic_hijack_element_blacklist": {
        "traffic_hijack_element_blacklist": [
          "www.taobao.com"
        ]
      },
      "traffic_hijack_element_count": 0,
      "traffic_hijack_element_whitelist": {
        "traffic_hijack_element_whitelist": [
          "www.taobao.com"
        ]
      },
      "username": "testUser",
      "waitTime_after_completion": 3
    },
    "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
    "TaskName": "test123",
    "TaskState": "1",
    "TaskType": "HTTP",
    "VpcConfig": {
      "Region": "cn-beijing",
      "SecurityGroupId": "sg-xxxxxx",
      "VpcId": "vpc-xxxxxx",
      "VswitchId": "vsw-xxxxxx"
    }
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidThe parameter is missing or invalid. %s参数缺失或者参数无效。
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403ForbiddenYou are not authorized to operate the specified resource.没有权限,请使用RAM进行授权
404ForbiddenTask Id does not exist-
406ExceedingQuotaExceeding quota limits.-
429Throttli∂ngExceptionThe request was denied due to request throttling.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2024-08-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-07-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-06-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-04-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2021-09-16OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情