根据传入参数创建健康探测模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alidns:CreateCloudGtmMonitorTemplate | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AcceptLanguage | string | 否 | 返回值语言,取值:
| en-US |
ClientToken | string | 否 | 用户生成的请求 token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。 | 1ae05db4-10e7-11ef-b126-00163e24**** |
Name | string | 是 | 健康检查探测模板的名称。为了方便区分和记忆,建议名称可以区分健康检查协议。 | Ping-IPv4 |
IpVersion | string | 是 | 探测节点 IP 地址的类型:
| IPv4 |
Protocol | string | 是 | 对目标 IP 地址发起探测的协议类型:
| ping |
Interval | integer | 是 | 每次检查的时间间隔(秒),默认每间隔 1 分钟探测一次,健康检查间隔最小支持 15 秒(面向旗舰版实例开放)。 | 60 |
Timeout | integer | 是 | 探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:
| 5000 |
EvaluationCount | integer | 是 | 重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:
| 2 |
FailureRate | integer | 是 | 所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:
| 50 |
ExtendInfo | string | 否 | Json 字符串扩展信息,各协议检查所需参数:
| {\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"} |
IspCityNodes | array<object> | 是 | 探测节点列表,具体信息可通过调用 ListCloudGtmMonitorNodes 获取 | |
NodeList | object | 是 | 探测节点。 | |
CityCode | string | 否 | 探测节点-城市编码。 | 503 |
IspCode | string | 否 | 探测节点-运营商编码。 | 465 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
"Success": true,
"TemplateId": "mtp-89518052425100****"
}
错误码
访问错误中心查看更多错误码。