全部產品
Search
文件中心

Alibaba Cloud DNS:DescribeCloudGtmMonitorTemplate - 擷取指定健康探測模板配置

更新時間:Sep 09, 2025

根據傳入參數擷取指定健康探測模板配置。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alidns:DescribeCloudGtmMonitorTemplate

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

AcceptLanguage

string

設定返回後可用性區域名稱的語言,取值:

  • zh-CN:中文。

  • en-US(預設值):英文。

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:當探測的目標地址類型為 IPv4 地址時適用;

  • IPv6:當探測的目標地址類型為 IPv6 地址時適用;

IPv4

Protocol

string

對目標 IP 位址發起探測的協議類型:

  • ping

  • tcp

  • http

  • https

ping

Interval

integer

每次檢查的時間間隔(秒),預設每間隔 1 分鐘探測一次,健全狀態檢查間隔最小支援 15 秒(面向旗艦版執行個體開放)。

60

Timeout

integer

探測逾時時間(毫秒),大於逾時時間未返回的資料包即判斷為健全狀態檢查逾時:

  • 2000

  • 3000

  • 5000

  • 10000

5000

EvaluationCount

integer

重試次數,連續多次監控出現異常,系統才將應用服務判斷為異常,以防止因為一些網路瞬間抖動等其他原因影響監控準確率。重試次數可選值為:

  • 1

  • 2

  • 3

2

FailureRate

integer

所選節點探測失敗比例(%),即健全狀態檢查異常的探測點占探測點總數的百分比,當失敗比例超過設定的閾值時,將服務地址判斷為異常。可設定的失敗比例閾值為:

  • 20

  • 50

  • 80

  • 100

50

ExtendInfo

string

Json 字串擴充資訊,各協議檢查所需參數:

  • http(s):

    host:執行 HTTP(S)監控時,指定 HTTP(S)要求標頭部資訊中攜帶的 Host 欄位,用於標識需要訪問的具體 HTTP 網站,預設為主網域名稱,如果目標網站的 host 有特殊要求,請自行修改;

    path:HTTP 路徑,使用者 HTTP(S)健全狀態檢查的 URL 路徑配置,系統預設填寫“/”;

    code:當執行 HTTP(S)監控時,根據 Web 服務器的返回碼判斷 Web 服務器是否正常工作,大於返回碼警示閾值時,系統認為應用服務出現異常:

    • 400:Bad Request,即如果 HTTP(S)請求攜帶了錯誤的請求參數,Web 服務器將返回大於 400 的返回碼,如果校正內容設定為“異常碼大於 400”,請務必在 URL 路徑中填寫精確的 URL 訪問路徑參數;

    • 500:Server Error,即如果 Web 服務器出現了某些異常,將返回大於 500 的異常碼,系統預設使用大於 500 的異常碼作為警示閾值;

    sni:是否開啟 sni,僅在 HTTPS 協議時使用。SNI(Server Name Indication)是 TLS 協議的一個擴充,它允許用戶端在發起 TLS 握手時指定想要串連的主機名稱。由於 TLS 握手發生在 HTTP 要求的任何資料被發送之前,SNI 允許伺服器在發送認證之前知道用戶端試圖訪問的服務,這使得伺服器可以選擇正確的認證來呈現給用戶端。

    • true-開啟

    • false-未開啟

    followRedirect:是否跟隨 3XX 重新導向

    • true:監控點擷取的狀態代碼為 3XX (301,302,303, 307,308) 時,跟隨跳轉;

    • false:不跳轉;

  • ping:

    packetNum:每次 Ping 監控,同時發出多少個 ICMP 資料包,可選 20、50、100

    packetLossRate:異常時丟包率,每次 ping 監控,對發出的 ICMP 資料包,計算丟包率(%)。丟包率=(遺失資料包/發送的總 ICMP 資料包數目)* 100%,達到丟包率閾值時,異常警示。丟包率可選值為:10、30、40、80、90、100

{\"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:BGP 節點

  • OVERSEAS:國際節點

  • ISP:電訊廠商節點

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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情