ListAllInstances - Alibaba Cloud Linux

此介面用於取得已納管/未納管執行個體清單並帶有執行個體資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sysom:ListAllInstances

list

*全部資源。

*

無

請求文法

GET /api/v1/am/instance/listAllInstances HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
region	string	否	地域 ID。	cn-hangzhou
instanceType	string	否	執行個體類型。	ecs
managedType	string	否	納管類型。	managed
filters	string	否	篩選資訊清單。	{}
current	string	否	目前所在分頁。	1
pageSize	string	否	每頁返回數目，預設 pageSize=10。	10
pluginId	string	否	外掛程式 ID。	01fc4a0b-f199-4885-9861-b4054a310fe7
maxResults	integer	否	一次取得的最大記錄數。	100
nextToken	string	否	分頁遊標。說明如果該參數不為空，表示還有更多資料。	U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw=
		否
		否

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822
code	string	狀態碼。	Success
message	string	錯誤訊息。如果 `code == Success`，則本欄位為空；否則本欄位包含請求錯誤訊息。	instance not exists
total	integer	查詢結果總數。	2
data	array<object>	返回資料。
	array<object>	返回結果。
instanceId	string	執行個體 ID。	i-bp17uabeke9v7n30abm2
osHealthScore	integer	作業系統健康分數。	100
resourceGroupName	string	資源群組名稱。	xxxx
instanceName	string	執行個體名稱。	test
installType	string	安裝類型。	console
instanceType	string	執行個體類型。	ecs
installLevel	string	安裝層級。	Cluster
attributes	array<object>	擴充資訊。
	object	擴充資訊。
infoValue	string	資訊值。	diagnosis
infoType	string	資訊類型。	instance_tag
infoKey	string	資訊鍵。	sysom
resourceGroupId	string	資源群組 ID。	3b24a621-acb3-11ef-8c90-00163e1029af
osName	string	作業系統名稱。	alios
status	string	執行個體的運行狀態，取值： Running：正在運行 Offline：離線說明處於 Offline 狀態的執行個體代表節點到 SysOM 伺服器端的心跳遺失，並不代表對應的 ECS 執行個體沒有運行。	Running
clusterId	string	叢集 ID。	3b24a621-acb3-11ef-8c90-00163e1029af
osArch	string	作業系統架構。	x86_64
kernelVersion	string	核心版本。	5.10.134-18.al8.x86_64
imageId	string	映像 ID。	aliyun_3_x64_20G_alibase_20250117.vhd
manageType	string	納管類型。	managed
manageLevel	string	納管層級。	cluster
clusterName	string	叢集名稱。	zjk_vpc_domain_1
publicIp	string	公網 IP 地址。	47.98.215.58
privateIp	string	私網 IP 地址。	172.21.172.7
agentConfigId	string	Agent 設定 ID。	test_id
agentConfigName	string	Agent 設定名稱。	test_name
maxResults	integer	最大返回數量。	20
nextToken	string	分頁遊標。說明不為空表示有更多資料。	c2f78a783f49457caba6bace6f6f79e4

樣本

正常返回樣本

JSON格式

{
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n",
  "code": "Success",
  "message": "instance not exists",
  "total": 2,
  "data": [
    {
      "instanceId": "i-bp17uabeke9v7n30abm2",
      "osHealthScore": 100,
      "resourceGroupName": "xxxx",
      "instanceName": "test",
      "installType": "console",
      "instanceType": "ecs",
      "installLevel": "Cluster",
      "attributes": [
        {
          "infoValue": "diagnosis",
          "infoType": "instance_tag",
          "infoKey": "sysom"
        }
      ],
      "resourceGroupId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osName": "alios",
      "status": "Running",
      "clusterId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osArch": "x86_64",
      "kernelVersion": "5.10.134-18.al8.x86_64",
      "imageId": "aliyun_3_x64_20G_alibase_20250117.vhd",
      "manageType": "managed",
      "manageLevel": "cluster",
      "clusterName": "zjk_vpc_domain_1",
      "publicIp": "47.98.215.58",
      "privateIp": "172.21.172.7",
      "agentConfigId": "test_id",
      "agentConfigName": "test_name"
    }
  ],
  "maxResults": 20,
  "nextToken": "c2f78a783f49457caba6bace6f6f79e4"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.

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

變更歷史

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