取得已納管/未納管執行個體資訊，資訊中包含ECS資訊。
介面說明
目前介面取得的執行個體清單是已經被 SysOM 納管的機器清單，如果某個 ECS 執行個體存在但是沒有被 SysOM 納管，則不會出現在清單當中。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sysom:ListInstancesWithEcsInfo |
get |
*全部資源。
|
無 | 無 |
請求文法
GET /api/v1/am/instance/listInstancesWithEcsInfo HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| region |
string |
是 |
透過區域篩選執行個體。 |
cn-shenzhen |
| instance_id |
string |
否 |
指定本欄位，則篩選出指定執行個體的 Agent 安裝情況。 |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
否 |
元件執行個體名稱。 |
block-load-balancer-hjdm9 |
| instance_id_name |
string |
否 |
透過執行個體名稱或者執行個體 ID 篩選，支援模糊查詢。 |
84b |
| is_managed |
integer |
否 |
透過執行個體的納管狀態篩選。 |
1 |
| instance_tag |
object |
否 |
透過執行個體標籤篩選。 |
|
| key |
string |
否 |
標籤 Key 值。 |
feature_dim_radar_chart |
| value |
string |
否 |
標籤 Value 值。 |
test |
| public_ip |
string |
否 |
透過公網 IP 位址篩選執行個體。 |
1.1.1.1 |
| private_ip |
string |
否 |
透過私網 IP 位址篩選執行個體。 |
1.1.1.1 |
| resource_group_name |
string |
否 |
透過資源群組名稱篩選執行個體。 |
default resource group |
| resource_group_id |
string |
否 |
透過資源群組 ID 篩選執行個體。 |
rg-xxxxxxx |
| resource_group_id_name |
string |
否 |
透過資源群組名稱或者資源群組 ID 篩選，支援模糊查詢。 |
default |
| health_status |
string |
否 |
透過健康狀態篩選執行個體。 |
healthy |
| os_name |
string |
否 |
透過執行個體作業系統名稱篩選。 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| current |
integer |
否 |
頁碼分頁時存在該欄位，表示目前頁。 |
1 |
| pageSize |
integer |
否 |
每頁大小，預設值為 10。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| code |
string |
狀態碼。 |
Success |
| data |
array<object> |
回傳資料。 |
|
|
array<object> |
回傳結果。 |
||
| cluster_id |
string |
叢集 ID。 |
cbf7a37bc905d4682a3338b3744810269 |
| instance_id |
string |
執行個體 ID。 |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
執行個體名稱。 |
allowed-repos-r2tzl |
| instance_tag |
array<object> |
執行個體標籤。 |
|
|
object |
|||
| tag_key |
string |
標籤的名稱。 |
test_tag_key |
| tag_value |
string |
標籤值。 |
test_tag_value |
| kernel_version |
string |
核心版本。 |
5.10.134-14.an8.x86_64 |
| os_arch |
string |
ECS 執行個體的架構。 |
x86 |
| os_health_score |
string |
執行個體的健康分數。 |
100 |
| os_name |
string |
執行個體的作業系統名稱。 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| private_ip |
string |
執行個體私網 IP。 |
1.1.1.1 |
| public_ip |
string |
執行個體公網 IP。 |
1.1.1.1 |
| resource_group_id |
string |
資源群組 ID。 |
rg-xxxxxx |
| resource_group_name |
string |
資源群組名稱。 |
default resource group |
| status |
string |
執行個體的運作狀態，取值：
說明
處於 Offline 狀態的執行個體代表節點到 SysOM 伺服器端的心跳遺失，並不代表對應的 ECS 執行個體沒有運作。 |
Running |
| message |
string |
錯誤資訊，空代表資料已經讀取完畢。 |
result: code=1 msg=(Request failed, status_code != 200) |
| request_id |
string |
請求 RequestId。 |
35F91AAB-5FDF-5A22-B211-C7C6B00817D0 |
| total |
integer |
總記錄數。 |
319 |
樣本
正常返回樣本
JSON格式
{
"code": "Success",
"data": [
{
"cluster_id": "cbf7a37bc905d4682a3338b3744810269",
"instance_id": "i-bp118piqcio9tiwgh84b",
"instance_name": "allowed-repos-r2tzl",
"instance_tag": [
{
"tag_key": "test_tag_key",
"tag_value": "test_tag_value"
}
],
"kernel_version": "5.10.134-14.an8.x86_64",
"os_arch": "x86",
"os_health_score": "100",
"os_name": "Alibaba Cloud Linux 3.2104 LTS 64bit",
"private_ip": "1.1.1.1",
"public_ip": "1.1.1.1",
"resource_group_id": "rg-xxxxxx",
"resource_group_name": "default resource group",
"status": "Running"
}
],
"message": "result: code=1 msg=(Request failed, status_code != 200)",
"request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
"total": 319
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。