文档

AddDnsGtmMonitor - 添加健康检查

更新时间:

创建健康检查。

调试

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

授权信息

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

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

请求参数

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

部分返回参数语言。默认值:en。取值范围:en、zh、ja。

en
AddrPoolIdstring

地址池 id。

pool1
ProtocolTypestring

检查协议:

  • HTTP
  • HTTPS
  • PING
  • TCP
TCP
Intervalinteger

检查间隔,单位秒。

60
EvaluationCountinteger

连续次数。

1
Timeoutinteger

超时时间,单位毫秒。

3000
MonitorExtendInfostring

扩展信息,各协议检查所需参数:

  • HTTP(S):

    • port:检查端口
    • host:Host 设置
    • path:URL 路径
    • code:返回码大于某个数值时则判定健康检查异常。
    • failureRate:失败率
    • sni:是否开启 sni,仅在 HTTPS 协议时使用。
      • true-开启
      • false-未开启
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
  • PING:

    • failureRate:失败率
    • packetNum:ping 包数
    • packetLossRate:ping 丢包率
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
  • TCP:

    • port:检查端口
    • failureRate:失败率
    • nodeType:地址池类型为 DOMAIN 时,健康检查监控节点类型:
      • IPV4
      • IPV6
该字段为JSON字符串 {"failureRate":50,"port":80}
IspCityNodeobject []

监控城市节点列表。

CityCodestring

监控节点-城市 code。

123
IspCodestring

监控节点-运营商 code。

123

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD579933522B
MonitorConfigIdstring

健康检查配置 id。

MonitorConfigId1

示例

正常返回示例

JSON格式

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "MonitorConfigId": "MonitorConfigId1"
}

错误码

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

  • 本页导读 (0)