文档

AddGtmMonitor - 添加健康检查(旧版)

更新时间:

创建健康检查。

调试

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

授权信息

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

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

请求参数

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

语言。

en
AddrPoolIdstring

地址池 ID。

xxxx
ProtocolTypestring

检查协议。取值:

  • HTTP
  • HTTPS
  • PING
  • TCP
HTTP
Intervalinteger

检查间隔,单位:秒,取值范围:60。

60
EvaluationCountinteger

连续失败次数。

3
Timeoutinteger

超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。

3000
MonitorExtendInfostring

扩展信息。根据不同协议,进行传参:

HTTP、HTTPS:

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

PING:

  • packetNum:ping 包数
  • packetLossRate:丢包率
  • failureRate:失败比例

TCP:

  • port:检查端口
  • failureRate:失败比例
{\"code\":200,\"path\":\"/index.htm\",\"host\":\"aliyun.com\"}
IspCityNodeobject []

监控城市节点列表。

CityCodestring

城市 Code。

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

503
IspCodestring

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

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

健康检查配置 ID

1234abc

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (0)