调用AddGtmMonitor创建健康检查。

调试

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

请求参数

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

系统规定参数。取值：AddGtmMonitor。

AddrPoolId String 是 xxxx

地址池ID
EvaluationCount Integer 是 3

连续次数
Interval Integer 是 60

检查间隔，单位：秒，取值范围：60。
MonitorExtendInfo String 是 {\"code\":200,\"path\":\"/index.htm\",\"host\":\"aliyun.com\"}

扩展信息。根据不同协议，进行传参：

HTTP、HTTPS：

  • port：检查端口
  • failureRate：失败率
  • code：返回码（大于此值会被判定为异常）。取值：400、500。
  • host：Host设置
  • path：URL路径

PING:

  • packetNum：ping包数
  • packetLossRate：ping丢包率
  • failureRate：失败率

TCP：

  • port：检查端口
  • failureRate：失败率
ProtocolType String 是 HTTP

检查协议。取值：

  • HTTP
  • HTTPS
  • PING
  • TCP
Timeout Integer 是 3000

超时时间，单位：毫秒，取值范围：2000、3000、5000、10000。
Lang String 否 en

用户语言
IspCityNode.N.CityCode String 否 503

城市Code。

具体取值可参考：DescribeGtmMonitorAvailableConfig接口返回数据。
IspCityNode.N.IspCode String 否 465

具体取值可参考：DescribeGtmMonitorAvailableConfig接口返回数据。

  • GroupType为BGP或Overseas时，IspCityNode.N.IspCode为非必传值，默认为465。
  • GroupType为非BGP或Overseas时，IspCityNode.N.IspCode为必传值。并与IspCityNode.N.CityCode匹配使用。

返回数据

名称 类型 示例值 描述
RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

请求ID
MonitorConfigId String 1234abc

健康检查配置ID

示例

请求示例

http(s)://alidns.aliyuncs.com/?Action=AddGtmMonitor
&AddrPoolId=xxxx
&EvaluationCount=3
&Interval=60
&MonitorExtendInfo={\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
&ProtocolType=HTTP
&Timeout=3000
&<公共请求参数>

正常返回示例

XML 格式 

<AddGtmMonitorResponse>
	  <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <MonitorConfigId>1234abc</MonitorConfigId>
</AddGtmMonitorResponse>

JSON 格式 

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

错误码

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