查询健康检查模板列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
alidns:SearchCloudGtmMonitorTemplates |
list |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AcceptLanguage |
string |
否 |
返回结果显示的语言。取值:
|
zh-CN |
PageNumber |
integer |
是 |
当前页数,起始值为 1,默认为 1。 |
1 |
PageSize |
integer |
是 |
分页查询时设置的每页行数,最大值 100,默认为 20。 |
20 |
Name |
string |
否 |
健康探测模板的名称,按照输入的关键字进行模糊搜索。 |
IPv4-Ping |
IpVersion |
string |
否 |
按照探测节点 IP 地址的类型进行精确搜索:
|
IPv4 |
Protocol |
string |
否 |
按照探测协议类型进行精确搜索:
|
ping |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
唯一请求识别码。 |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
TotalPages |
integer |
总页数。 |
1 |
TotalItems |
integer |
搜索到的健康探测模板总条目数。 |
1 |
PageSize |
integer |
分页查询时设置的每页行数,最大值 100,默认为 20。 |
20 |
PageNumber |
integer |
当前页数,起始值为 1,默认为 1。 |
1 |
Templates |
object |
||
Template |
array<object> |
健康探测模板列表。 |
|
object |
健康探测模板信息。 |
||
TemplateId |
string |
健康探测模板 ID,唯一标识健康探测模板。 |
mtp-89518052425100**80 |
CreateTime |
string |
健康探测模板的创建时间。 |
2024-03-23T13:09Z |
CreateTimestamp |
integer |
健康探测模板的创建时间(时间戳)。 |
1527690629357 |
UpdateTime |
string |
健康探测模板的最后一次修改时间。 |
2024-03-29T13:20Z |
UpdateTimestamp |
integer |
健康探测模板的最后一次修改时间(时间戳)。 |
1527690629357 |
Name |
string |
健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。 |
IPv4-Ping |
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 |
object |
||
IspCityNode |
array<object> |
探测节点列表。 |
|
object |
探测节点信息。 |
||
CountryCode |
string |
国家编码。 |
001 |
CountryName |
string |
国家名称。 |
中国 |
CityCode |
string |
城市编码。 |
503 |
CityName |
string |
城市名称。 |
张家口市 |
GroupType |
string |
探测节点分组类型:
|
BGP |
GroupName |
string |
探测节点分组类型名称。 |
BGP |
IspCode |
string |
运营商编码。 |
465 |
IspName |
string |
运营商名称。 |
阿里巴巴 |
Remark |
string |
健康探测模板的备注。 |
test |
示例
正常返回示例
JSON
格式
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"TotalPages": 1,
"TotalItems": 1,
"PageSize": 20,
"PageNumber": 1,
"Templates": {
"Template": [
{
"TemplateId": "mtp-89518052425100**80",
"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\\\"}",
"IspCityNodes": {
"IspCityNode": [
{
"CountryCode": "001",
"CountryName": "中国",
"CityCode": "503",
"CityName": "张家口市",
"GroupType": "BGP",
"GroupName": "BGP",
"IspCode": "465",
"IspName": "阿里巴巴"
}
]
},
"Remark": "test"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。