全部产品
Search
文档中心

云解析 DNS:ListCloudGtmMonitorTemplates - 获取健康探测模板列表

更新时间:Nov 04, 2024

根据传入参数获取健康探测模板列表。

调试

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

授权信息

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

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

请求参数

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

返回值语言,取值:

  • zh-CN:中文。

  • en-US(默认值):英文。

zh-CN
PageNumberinteger

当前页数,起始值为 1,默认为 1

1
PageSizeinteger

分页查询时设置的每页行数,最大值 100,默认为 20。

20
Namestring

健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。

IPv4-Ping
IpVersionstring

探测节点 IP 地址的类型:

  • IPv4:当探测的目标地址类型为 IPv4 地址时适用。

  • IPv6:当探测的目标地址类型为 IPv6 地址时适用。

IPv4
Protocolstring

对目标 IP 地址发起探测的协议类型:

  • ping

  • tcp

  • http

  • https

ping

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

75446CC1-FC9A-4595-8D96-089D73D7A63D
TotalPagesinteger

数据分页后总页数。

2
TotalItemsinteger

获取的健康探测模板列表总条目数。

30
PageSizeinteger

分页查询时设置的每页行数,最大值 100,默认为 20。

20
PageNumberinteger

当前页数,起始值为 1,默认为 1。

1
Templatesarray<object>

健康探测模板列表。

Templateobject

健康探测模板详细信息。

TemplateIdstring

健康探测模板 ID,唯一标识健康探测模板。

mtp-89518052425100****
CreateTimestring

健康探测模板创建时间。

2024-03-23T13:09Z
CreateTimestamplong

健康探测模板创建时间(时间戳)。

1527690629357
UpdateTimestring

健康探测模板最后一次修改时间。

2024-03-29T13:20Z
UpdateTimestamplong

健康检查模板配置修改时间(时间戳)。

1527690629357
Namestring

健康检查探测模板的名称,一般为了方便配置人员区分和记忆。

IPv4-Ping
IpVersionstring

探测节点 IP 地址的类型:

  • IPv4:当探测的目标地址类型为 IPv4 地址时适用。

  • IPv6:当探测的目标地址类型为 IPv6 地址时适用。

IPv4
Protocolstring

对目标 IP 地址发起探测的协议类型:

  • ping

  • tcp

  • http

  • https

ping
Intervalinteger

每次检查的时间间隔(秒),默认每间隔 1 分钟探测一次,健康检查间隔最小支持 15 秒(面向旗舰版实例开放)。

60
Timeoutinteger

探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:

  • 2000

  • 3000

  • 5000

  • 10000

5000
EvaluationCountinteger

重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:

  • 1

  • 2

  • 3

2
FailureRateinteger

所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:

  • 20

  • 50

  • 80

  • 100

50
ExtendInfostring

Json 字符串扩展信息,各协议检查所需参数:

  • http(s):

    host:执行 HTTP(S)监控时,指定 HTTP(S)请求头部信息中携带的 Host 字段,用于标识需要访问的具体 HTTP 网站,默认为主域名,如果目标网站的 host 有特殊要求,请自行修改;

    path:HTTP 路径,用户 HTTP(S)健康检查的 URL 路径配置,系统默认填写“/”;

    code:当执行 HTTP(S)监控时,根据 Web 服务器的返回码判断 Web 服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:

    • 400:Bad Request,即如果 HTTP(S)请求携带了错误的请求参数,Web 服务器将返回大于 400 的返回码,如果校验内容设置为“异常码大于 400”,请务必在 URL 路径中填写精确的 URL 访问路径参数;

    • 500:Server Error,即如果 Web 服务器出现了某些异常,将返回大于 500 的异常码,系统默认使用大于 500 的异常码作为报警阈值;

    sni:是否开启 sni,仅在 HTTPS 协议时使用。SNI(Server Name Indication)是 TLS 协议的一个扩展,它允许客户端在发起 TLS 握手时指定想要连接的主机名。由于 TLS 握手发生在 HTTP 请求的任何数据被发送之前,SNI 允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。

    • true-开启

    • false-未开启

    followRedirect:是否跟随 3XX 重定向

    • true:监控点获取的状态码为 3XX (301,302,303, 307,308) 时,跟随跳转;

    • false:不跳转;

  • ping:

    packetNum:每次 Ping 监控,同时发出多少个 ICMP 数据包,可选 20、50、100

    packetLossRate:异常时丢包率,每次 ping 监控,对发出的 ICMP 数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总 ICMP 数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100

{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodesarray<object>

探测节点列表,具体信息可通过调用 ListCloudGtmMonitorNodes 获取。

IspCityNodeobject

探测节点。

CountryCodestring

国家编码。

001
CountryNamestring

国家名称。

中国
CityCodestring

城市编码。

503
CityNamestring

城市名称。

张家口市
GroupTypestring

探测节点分组类型:

  • BGP:BGP 节点

  • OVERSEAS:国际节点

  • ISP:运营商节点

BGP
GroupNamestring

探测节点分组名称。

BGP节点
IspCodestring

运营商编码。

465
IspNamestring

运营商名称。

阿里巴巴
Remarkstring

健康探测模板的备注。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TotalPages": 2,
  "TotalItems": 30,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "IPv4-Ping",
        "IpVersion": "IPv4",
        "Protocol": "ping",
        "Interval": 60,
        "Timeout": 5000,
        "EvaluationCount": 2,
        "FailureRate": 50,
        "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}\n",
        "IspCityNodes": {
          "IspCityNode": [
            {
              "CountryCode": "001",
              "CountryName": "中国",
              "CityCode": "503",
              "CityName": "张家口市",
              "GroupType": "BGP",
              "GroupName": "BGP节点",
              "IspCode": "465",
              "IspName": "阿里巴巴"
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

错误码

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