取得執行個體狀態。
介面說明
本介面用於取得被 SysOM 納管的機器清單。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sysom:ListInstanceStatus |
list |
*全部資源。
|
無 | 無 |
請求文法
GET /api/v1/am/instance/list_instance_status HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| current |
integer |
否 |
頁碼分頁時存在該欄位，表示目前頁（從 1 開始）。 |
1 |
| pageSize |
integer |
否 |
每頁回傳數量，預設 pageSize=10。 |
10 |
| instance |
string |
否 |
執行個體 ID。 |
i-wz9b9vucz1iubsz355rh |
| status |
string |
否 |
根據狀態過濾執行個體清單，如果指定了本欄位，將會過濾出對應狀態的執行個體清單。 枚舉值：
|
Running |
| region |
string |
否 |
地域 ID。 |
cn-shenzhen |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID，可用於全鏈路診斷。 |
5BC79EF5-798B-5499-9683-4E14EBBBF712 |
| code |
string |
狀態碼
|
Success |
| data |
array<object> |
回傳資料。 |
|
|
object |
回傳資料。 |
||
| instance |
string |
執行個體 ID。 |
i-wz9d00ut2ska3mlyhn6j |
| region |
string |
地域 ID。 |
cn-hangzhou |
| status |
string |
執行個體的運行狀態，取值：
說明
處於 Offline 狀態的執行個體代表節點到 SysOM 伺服器端的心跳遺失，並不代表對應的 ECS 執行個體沒有運行。 |
Running |
| message |
string |
錯誤資訊
|
SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom |
| total |
integer |
總記錄數。 |
218 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712",
"code": "Success",
"data": [
{
"instance": "i-wz9d00ut2ska3mlyhn6j",
"region": "cn-hangzhou",
"status": "Running"
}
],
"message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
"total": 218
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。