調用DescribeHealthStatus查看執行個體和節點的健康狀態-雲原生資料倉儲AnalyticDB-阿里雲

查看執行個體和節點的健康狀態。

介面說明

本介面用於查看儲存彈性模式和 Serverless 版本的 AnalyticDB PostgreSQL 版的執行個體、協調節點（也稱 Master 節點）以及計算節點（也稱 Segment 節點）的健康狀態。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:DescribeHealthStatus

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-bp12ga6v69h86****
Key	string	是	績效參數名稱，多個指標用英文半形（,）分隔，具體資訊，請參見績效參數表。	node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

返回參數

名稱	類型	描述	樣本值
	object
Status	object	效能監控具體資訊，由參數名、狀態和和指標值構成。只有請求參數 Key 中傳入了績效參數才會返回對應的監控資訊，例如請求參數 Key 僅包含adbpg_status，則返回資訊中僅返回adbpg_status的監控資訊。更多績效參數資訊，請參見績效參數表。	{"node_master_connection_status":{"Status":"healthy","Value":1.6}}
adbpg_status	object	執行個體健康狀態。
Status	string	執行個體健康狀態。取值說明： critical：任意一個 Master 節點或 Segment 節點不可用，控制台顯示為紅色。 healthy：所有節點均可用，控制台顯示為綠色。	healthy
Value	number	執行個體健康狀態的指標值。取值說明： 1 表示 healthy。 0 表示 critical。	1
adbpg_connection_status	object	執行個體串連狀態。
Status	string	執行個體串連狀態。取值說明： critical：執行個體串連數使用率大於 95%，控制台顯示為紅色。 warning：執行個體串連數使用率大於 90%且小於等於 95%，控制台顯示為黃色。 healthy：執行個體串連數使用率小於等於 90%，控制台顯示為綠色。說明執行個體串連數使用率為所有 Master 節點和 Segment 節點的串連數使用率的最大值。	healthy
Value	number	執行個體串連數使用率的指標值，即所有 Master 節點和 Segment 節點的串連數使用率的最大值。單位：%。	1.71
adbpg_disk_status	object	執行個體儲存狀態。說明僅儲存彈性模式會返回該值。
Status	string	執行個體儲存狀態。取值說明： critical：執行個體儲存水位大於等於 90%，控制台顯示為紅色，執行個體將被鎖定。 warning：執行個體儲存水位大於等於 70%且小於 90%，控制台顯示為黃色。 healthy：執行個體儲存水位小於 70%，控制台顯示為綠色，執行個體儲存狀態健康。說明執行個體儲存水位為所有 Segment 節點的儲存水位的平均值。	healthy
Value	number	執行個體儲存水位的指標值，即所有 Segment 節點的儲存水位的平均值。單位：%。	1.52
adbpg_disk_usage_percent	object	執行個體儲存水位。說明僅儲存彈性模式會返回該值。
Status	string	執行個體儲存水位狀態。取值說明： critical：執行個體儲存水位大於等於 90%，執行個體將被鎖定。 warning：執行個體儲存水位大於等於 70%且小於 90%。 healthy：執行個體儲存水位小於 70%，執行個體儲存狀態健康。說明執行個體儲存水位為所有 Segment 節點的儲存水位的平均值。	healthy
Value	number	執行個體儲存水位的指標值，所有 Segment 節點的儲存水位的平均值。單位：%。	1.52
adbpg_master_disk_usage_percent_max	object	最大執行個體協調節點儲存水位，即執行個體下所有 Master 節點中的最大儲存水位。說明僅儲存彈性模式會返回該值。
Status	string	Master 節點最大儲存水位狀態。取值說明： critical：水位大於等於 90%，執行個體將被鎖定。 warning：水位大於等於 70%且小於 90%。 healthy：水位小於 70%，執行個體儲存狀態健康。	healthy
Value	number	Master 節點最大儲存水位的指標值。單位：%。	1.34
adbgp_segment_disk_usage_percent_max	object	最大執行個體計算節點儲存水位，即執行個體下所有 Segment 節點中的最大儲存水位。說明僅儲存彈性模式會返回該值。
Status	string	Segment 節點最大儲存水位狀態。取值說明： critical：水位大於等於 90%，執行個體將被鎖定。 warning：水位大於等於 80%且小於 90%。 healthy：水位小於 80%，執行個體儲存狀態健康。	healthy
Value	number	Segment 節點最大儲存水位的指標值。單位：%。	1.52
node_master_status	object	協調節點健康狀態，即 Master 節點的健康狀態。
Status	string	Master 節點健康狀態。取值說明： critical：任意一個主 Master 節點或副 Master 節點不可用，控制台顯示為紅色。 healthy：所有 Master 節點均可用，控制台顯示為綠色。	healthy
Value	number	Master 節點健康狀態的指標值。取值說明： 1 表示 healthy。 0 表示 critical。	1
node_segment_disk_status	object	計算節點儲存狀態，即 Segment 節點的儲存狀態。說明僅儲存彈性模式會返回該值。
Status	string	Segment 節點儲存狀態。取值說明： critical：Segment 節點儲存水位大於等於 90%，控制台顯示為紅色，執行個體將被鎖定。 warning：Segment 節點儲存水位大於等於 80%且小於 90%，控制台顯示為黃色。 healthy：Segment 節點儲存水位小於 80%，控制台顯示為綠色，執行個體儲存狀態健康。說明 Segment 節點儲存水位為所有 Segment 節點的儲存水位的最大值。	healthy
Value	number	Segment 節點的最大儲存水位的指標值。單位：%。	1.52
node_master_connection_status	object	協調節點串連健康狀態，即 Master 節點的串連健康狀態。
Status	string	Master 節點串連健康狀態。取值說明： critical：Master 節點串連數使用率大於等於 95%，控制台顯示為紅色。 warning：Master 節點串連數使用率大於等於 90%且小於 95%，控制台顯示為黃色。 healthy：Master 節點串連數使用率小於 90%，控制台顯示為綠色。說明 Master 節點串連數使用率為所有 Master 節點中串連數使用率的最大值。	healthy
Value	number	Master 節點的串連數使用率的指標值，即所有 Master 節點中串連數使用率的最大值。單位：%。	1.71
node_segment_connection_status	object	計算節點串連健康狀態，即 Segment 節點的串連健康狀態。
Status	string	Segment 節點串連健康狀態。取值說明： critical：Segment 節點串連數使用率大於等於 95%，控制台顯示為紅色。 warning：Segment 節點串連數使用率大於等於 90%且小於 95%，控制台顯示為黃色。 healthy：Segment 節點串連數使用率小於 90%，控制台顯示為綠色。說明 Segment 節點的串連數使用率為所有 Segment 節點中的串連數使用率最大值。	healthy
Value	number	Segment 節點的串連數使用率的指標值，即所有 Segment 節點中串連數使用率的最大值。單位：%。	0.48
adbpg_master_status	object	協調節點狀態，即 Master 節點的可用狀態。
Status	string	Master 節點的可用狀態。取值說明： critical：主備節點均不可用，控制台顯示為紅色。 warning：主節點或備節點不可用，控制台顯示為黃色。 healthy：所有節點均可用，控制台顯示為綠色。	healthy
Value	number	Master 節點的可用狀態的指標值。取值說明：	1
adbpg_segment_status	object	計算節點狀態，即 Segment 節點的可用狀態。
Status	string	Segment 節點的可用狀態。取值說明： critical：主備節點均不可用，控制台顯示為紅色。 warning：大於等於 50%節點不可用，控制台顯示為黃色。 healthy：所有節點均可用，控制台顯示為綠色。	healthy
Value	number	Segment 節點的可用狀態的指標值。	1
adbpg_instance_total_data_gb	object	執行個體儲存資料總量。
Value	number	執行個體儲存資料總量，單位 GB。	4.1
adbpg_instance_hot_data_gb	object	熱資料存放區總量。
Value	number	熱資料存放區總量，單位 GB。	4.1
adbpg_instance_cold_data_gb	object	冷資料存放區總量
Value	number	冷資料存放區總量，單位 GB。	0
RequestId	string	請求 ID。	D97B4191-104D-10CE-8BC5-53**********
DBClusterId	string	執行個體 ID。	gp-bp12ga6v69h86****

樣本

正常返回樣本

JSON格式

{
  "Status": {
    "adbpg_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "adbpg_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_disk_usage_percent": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_master_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.34
    },
    "adbgp_segment_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "node_segment_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "node_segment_connection_status": {
      "Status": "healthy",
      "Value": 0.48
    },
    "adbpg_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_segment_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_instance_total_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_hot_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_cold_data_gb": {
      "Value": 0
    }
  },
  "RequestId": "D97B4191-104D-10CE-8BC5-53**********",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。