根據傳入參數擷取指定健康探測模板配置。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
alidns:DescribeCloudGtmMonitorTemplate |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AcceptLanguage |
string |
否 |
設定返回後可用性區域名稱的語言,取值:
|
zh-CN |
| TemplateId |
string |
是 |
要查詢的健康探測模板 ID,唯一標識健康探測模板。 |
mtp-89518052425100**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
唯一請求識別碼。 |
6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF |
| TemplateId |
string |
健康探測模板 ID,唯一標識健康探測模板。 |
mtp-89518052425100**** |
| CreateTime |
string |
健康探測模板建立時間。 |
2024-03-23T13:09Z |
| CreateTimestamp |
integer |
健康探測模板建立時間(時間戳記)。 |
1527690629357 |
| UpdateTime |
string |
健全狀態檢查模板配置修改時間。 |
2024-03-29T13:20Z |
| UpdateTimestamp |
integer |
健全狀態檢查模板配置修改時間(時間戳記)。 |
1527690629357 |
| 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 |
object |
||
| IspCityNode |
array<object> |
探測節點列表,具體資訊可通過調用 ListCloudGtmMonitorNodes 擷取。 |
|
|
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": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
"TemplateId": "mtp-89518052425100****",
"CreateTime": "2024-03-23T13:09Z",
"CreateTimestamp": 1527690629357,
"UpdateTime": "2024-03-29T13:20Z",
"UpdateTimestamp": 1527690629357,
"Name": "Ping-IPv4",
"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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。