華為云計算 云知識 查詢健康檢查詳情ShowHealthmonitors
查詢健康檢查詳情ShowHealthmonitors

 

功能介紹

查詢健康檢查詳情。

調(diào)試

您可以在API Explorer中直接運行調(diào)試該接口。

URI

GET /v2/{project_id}/elb/healthmonitors/{healthmonitor_id}

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

操作用戶的項目ID。

獲取方法詳見獲取項目ID。

healthmonitor_id

String

健康檢查id。

請求消息

響應(yīng)消息

表2 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

healthmonitor

Healthmonitor object

健康檢查對象。詳見表3。

表3 healthmonitor字段說明

參數(shù)

參數(shù)類型

描述

id

String

健康檢查ID。

tenant_id

String

健康檢查所在的項目ID。

project_id

String

此參數(shù)和tenant_id參數(shù)含義一樣,均指健康檢查所在的項目ID。

name

String

健康檢查名稱。

delay

Integer

健康檢查間隔,單位秒,取值范圍[1,50]。

max_retries

Integer

健康檢查最大重試次數(shù),取值范圍[1,10]。

pools

Array of Pools objects

健康檢查關(guān)聯(lián)的后端 云服務(wù)器 組的ID列表。詳見表6

admin_state_up

Boolean

健康檢查的管理狀態(tài)。

該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。

  • true表示開啟。
  • false表示關(guān)閉。

timeout

Integer

健康檢查超時時間,單位秒,取值范圍[1,50]。

說明:

建議該值小于delay的值。

type

String

健康檢查的類型。

取值范圍:TCP、UDP_CONNECT、HTTP。

monitor_port

Integer

健康檢查端口號,取值范圍[1,65535]。

默認為空,表示使用后端云服務(wù)器的protocol_port作為健康檢查的檢查端口。

expected_codes

String

期望HTTP響應(yīng)狀態(tài)碼,指定下列值:

單值,例如200;

列表,例如200,202;

區(qū)間,例如200-204。

僅當(dāng)type為HTTP時生效。

暫時不支持該字段,統(tǒng)一置為200。

domain_name

String

健康檢查時,發(fā)送的http請求的域名。

僅當(dāng)type為HTTP時生效。

默認為空,表示使用 負載均衡 器的vip_address作為http請求的目的地址。

以數(shù)字或字母開頭,只能包含數(shù)字、字母、’-’、’.’。

例如:www.test.com

url_path

String

健康檢查時發(fā)送的http請求路徑。默認為“/”。

以“/”開頭。

僅當(dāng)type為HTTP時生效。

例如:“/test”

http_method

String

HTTP請求的方法;默認值:GET

取值范圍:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。

僅當(dāng)type為HTTP時生效。

說明:

該字段為預(yù)留字段,暫未啟用。

表4 pools字段說明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

后端服務(wù)器組id

請求示例

  • 請求樣例1 查詢健康檢查詳情
    GET https://{endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/healthmonitors/b7633ade-24dc-4d72-8475-06aa22be5412

響應(yīng)示例

  • 響應(yīng)樣例1
    {
      "healthmonitor": {
        "name": "",
        "admin_state_up": true,
        "tenant_id": "145483a5107745e9b3d80f956713e6a3",
        "project_id": "145483a5107745e9b3d80f956713e6a3",
        "domain_name": null,
        "delay": 10,
        "expected_codes": "200",
        "max_retries": 10,
        "http_method": "GET",
        "timeout": 10,
        "pools": [
          {
            "id": "bb44bffb-05d9-412c-9d9c-b189d9e14193"
          }
        ],
        "url_path": "/",
        "type": "HTTP",
        "id": "61c24cba-19bb-45c1-a013-7565e5f98872",
        "monitor_port": 112
      }
    }

返回碼

請參見狀態(tài)碼