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

 

功能介紹

查詢健康檢查詳情。

調(diào)用方法

請參見如何調(diào)用API

URI

GET /v1/health-checks/{health_check_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

health_check_id

String

健康檢查ID。

最小長度:1

最大長度:36

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

health_check

HealthCheckDetail object

健康檢查實例。

request_id

String

請求ID。

表4 HealthCheckDetail

參數(shù)

參數(shù)類型

描述

id

String

健康檢查ID。

endpoint_group_id

String

終端節(jié)點組ID。

protocol

String

健康檢查的協(xié)議。

枚舉值:

  • TCP

status

String

配置狀態(tài),取值:

  • ACTIVE:運行中

  • PENDING:待定

  • ERROR:錯誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

port

Integer

健康檢查的端口。

最小值:1

最大值:65535

interval

Integer

健康檢查的時間間隔,單位為秒。

最小值:1

最大值:60

timeout

Integer

健康檢查的超時時間,單位為秒。建議該值小于interval的值。

最小值:1

最大值:60

max_retries

Integer

最大重試次數(shù)。將終端節(jié)點的狀態(tài)從“健康”設(shè)置為“不健康”或從“不健康”設(shè)置為“健康”所需的連續(xù)健康檢查次數(shù)。

最小值:1

最大值:10

created_at

String

創(chuàng)建時間。

updated_at

String

更新時間。

domain_id

String

租戶ID。

enabled

Boolean

是否開啟健康檢查。

frozen_info

FrozenInfo object

云服務(wù)或資源實例凍結(jié)信息。

表5 FrozenInfo

參數(shù)

參數(shù)類型

描述

status

Integer

云服務(wù)或資源實例狀態(tài),取值:

  • 0:解凍/正常(云服務(wù)恢復正常)。

  • 1:凍結(jié)(資源和數(shù)據(jù)會保留,但租戶無法再正常使用云服務(wù))。

  • 2:刪除/終止(資源和數(shù)據(jù)將清除)。

最小值:0

最大值:2

effect

Integer

在凍結(jié)/解凍操作下,取值:

  • 1(默認值):凍結(jié)可釋放。

  • 2:凍結(jié)不可釋放。

  • 3:凍結(jié)后不可續(xù)費。

最小值:1

最大值:3

缺省值:1

scene

Array of strings

更新云服務(wù)狀態(tài)的業(yè)務(wù)場景列表,取值:

  • ARREAR(默認值):欠費場景。為正常的運營業(yè)務(wù)場景,包括包周期資源到期、按需資源扣費失敗。

  • POLICE:公安凍結(jié)場景。

  • ILLEGAL:違規(guī)凍結(jié)場景。

  • VERIFY:客戶未實名認證凍結(jié)場景。

  • PARTNER:合作伙伴凍結(jié)(合作伙伴凍結(jié)子客戶資源)。

最大長度:16

請求示例

查詢健康檢查詳情

GET https://{ga_endpoint}/v1/health-checks/c2b210b2-60c4-449d-91e2-9e9ea1dd7442

響應(yīng)示例

狀態(tài)碼: 200

操作成功

{
  "health_check" : {
    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7442",
    "endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "protocol" : "TCP",
    "status" : "ACTIVE",
    "port" : 3333,
    "interval" : 30,
    "timeout" : 30,
    "max_retries" : 1,
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "enabled" : true,
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯誤碼

請參見錯誤碼。