ListInstanceHealth - Alibaba Cloud Linux

取得一定時間內叢集節點/Pod健康度清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sysom:ListInstanceHealth

list

*全部資源。

*

無

請求文法

GET /api/v1/openapi/cluster_health/range/instance_health_list HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
cluster	string	否	叢集 ID。	2dc6f3be-bf24-4070-8d3a-c03c26850532
instance	string	否	執行個體 ID。	i-wz9d00ut2ska3mlyhn6j
start	number	是	開始時間。	1725797727754
end	number	是	結束時間。	1725801327754
current	integer	否	目前所在分頁。	1
pageSize	integer	否	每頁大小，預設值為 5，取值範圍【1,100】。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
code	string	狀態碼。 `code == Success` 則代表授權成功；其它狀態碼代表授權失敗，授權失敗時查看 `message` 欄位取得詳細的錯誤資訊。	SysomOpenAPI.ServerError
data	array<object>	傳回資料。
	object	回應資料。
images	array	Pod 中容器的映像名稱清單。
	string	容器映像名稱。	alinux3:latest
instance	string	執行個體 ID。	i-wz9d00ut2ska3mlyhn6j
namespace	string	Pod 所在的命名空間。	default
pod	string	Pod 名稱。	test-pod
region_id	string	地域 ID。	cn-shanghai
score	number	健康分數值。	100
status	string	執行個體的執行狀態，取值： Running：正在執行 Offline：離線說明處於 Offline 狀態的執行個體代表節點到 SysOM 伺服器端的心跳遺失，並不代表對應的 ECS 執行個體沒有執行。	Running
message	string	錯誤資訊。如果 `code == Success`，則本欄位為空；否則本欄位包含請求錯誤資訊。	Query no data
request_id	string	請求 RequestId。	35F91AAB-5FDF-5A22-B211-C7C6B00817D0
total	integer	查詢結果總數。	42

樣本

正常返回樣本

JSON格式

{
  "code": "SysomOpenAPI.ServerError",
  "data": [
    {
      "images": [
        "alinux3:latest"
      ],
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "namespace": "default",
      "pod": "test-pod",
      "region_id": "cn-shanghai",
      "score": 100,
      "status": "Running"
    }
  ],
  "message": "Query no data",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

錯誤碼

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

變更歷史

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