查询健康检查模板列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
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 |
返回参数
示例
正常返回示例
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"
}
]
}
}
错误码
访问错误中心查看更多错误码。