首页 云监控 开发参考 API参考 API目录 站点监控 DescribeSiteMonitorList - 查询站点监控任务列表

DescribeSiteMonitorList - 查询站点监控任务列表

更新时间: 2024-01-19 16:24:34

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

站点监控任务 ID。

a1ecd34a-8157-44d9-b060-14950837****
TaskTypestring

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

HTTP
Keywordstring

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

说明 支持根据任务名称或任务地址模糊搜索。
site
Pageinteger

分页页码。默认值:1。

1
PageSizeinteger

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

10
TaskStatestring

任务状态。取值:

  • 1:正常。

  • 2:禁用。

1

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

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
Successstring

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

successful
PageNumberinteger

分页页码。

1
PageSizeinteger

每页显示记录条数。

10
TotalCountinteger

总记录条数。

1
SiteMonitorsobject []

站点监控任务列表。

TaskTypestring

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

TCP
UpdateTimestring

站点监控任务更新时间。

2022-03-08 17:14:31
Intervalstring

探测频率。单位:分钟。

1
TaskStatestring

任务状态。取值:

  • 1:正常。

  • 2:禁用。

1
CreateTimestring

任务的创建时间。

2021-11-01 11:05:18
TaskNamestring

站点监控任务名称。

新的探测任务
Addressstring

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

https://aliyun.com
TaskIdstring

站点监控任务 ID。

f5783760-1b39-4b6b-80e8-453d962a****
OptionsJsonobject

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

passwordstring

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

123****
request_formatstring

HTTP 请求内容格式。取值:

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

匹配响应内容。

  • 十六进制格式:当请求的内容是字节串,且无法用可见字符表达时,可以将字节串转换为十六进制表示的可见字符串形式。具体转换规则为:一个字节转换成二字节的十六进制字符,例如:1 字节(1B)转换成十六进制为01, 27 字节(27B)转换成十六进制为1B。二进制数组(Java 形式)为{(byte)1, (byte)27},转换成十六进制为011b011B。站点监控对十六进制不区分大小写。将字符串011B填入请求内容中,同时请求内容格式选择十六进制格式。

  • 文本格式:普通文本指字符串,即由可见字符组成的字符串。

cf0f85
failure_ratefloat

丢包率。

说明 该参数仅适用于 PING 探测类型。
0.5
time_outlong

超时时间。单位:毫秒。

3000
headerstring

HTTP 请求头。格式为key1:value1,通过回车键换行。

testKey:testValue
cookiestring

发送 HTTP 请求的 Cookie 文本。

lang=en
portinteger

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

80
ping_numinteger

PING 探测的次数设置。

20
authenticationinteger

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

  • 0:开启。
  • 1:关闭。
1
http_methodstring

HTTP 的请求方法。取值:

  • get
  • post
  • head
get
match_ruleinteger

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

  • 0:包含。
  • 1:不包含。
0
dns_match_rulestring

DNS 的匹配规则。取值:

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

HTTP 探测请求内容。

cf0f85
usernamestring

FTP、SMTP 或 POP3 的用户名。

testUser
response_formatstring

HTTP 响应内容格式。取值:

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

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

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

指定 DNS 解析服务器的域名或 IP 地址。

192.168.XX.XX
enable_operator_dnsboolean

是否使用运营商的 DNS。

  • true(默认值):使用运营商的 DNS。
  • false:不使用运营商的 DNS。使用默认 DNS 或指定服务器的 DNS。
true
attemptslong

DNS 失败后重试次数。

3
protocolstring

DNS 探测协议类型。取值:

  • udp(默认值)
  • tcp
  • tcp-tls
udp
proxy_protocolboolean

是否开启 ProxyProtocol。取值:

  • false(默认值):不开启 ProxyProtocol。
  • true:开启 ProxyProtocol。
false
acceptable_response_codestring

可接受的状态码。

说明 建议您使用断言配置。
400
isBase64Encodestring

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

  • true:对密码进行 base64 解码存储。
  • false(默认值):不对密码进行 base64 解码存储。
false
cert_verifyboolean

是否验证证书。取值:

  • false(默认值):忽略证书验证。
  • true:证书验证。
false
unfollow_redirectboolean

如果出现 301 或 302 状态码,是否跟随再次做重定向探测。取值:

  • true:不跟随跳转。
  • false(默认值):跟随跳转。
false
diagnosis_mtrboolean

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

  • false(默认值):不开启自动 MTR 网络诊断。
  • true 开启自动 MTR 网络诊断。
false
diagnosis_pingboolean

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

  • false(默认值):不开启。
  • true:开启。
false
retry_delayinteger

探测失败后重试次数。

1
assertionsobject []

断言配置组。

propertystring

断言内容解析路径。

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

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

json path
typestring

断言类型。取值:

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

断言比较操作符。取值:

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

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

1000
AgentGroupstring

探针类型。取值:

  • PC:PC 端。
  • MOBILE:移动端。
PC

示例

正常返回示例

JSON格式

{
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "新的探测任务",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "json path",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidQueryParameter%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.
406ExceedingQuotaExceeding quota limits.
409%s%s
429ThrottlingExceptionThe request was denied due to request throttling.
500InternalError%s

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

变更历史

变更时间变更内容概要操作
2023-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
    删除错误码:402
    删除错误码:403
    删除错误码:406
    删除错误码:409
    删除错误码:429
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2021-09-16OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
    删除错误码:402
    删除错误码:403
    删除错误码:406
    删除错误码:409
    删除错误码:429
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
阿里云首页 云监控 相关技术圈