呼叫 DescribeCloudAssistantStatus 查詢一台或者多台執行個體是否安裝了雲端助手 Agent。如果已安裝了雲端助手,還將查詢雲端助手命令執行的總數量、正在執行的數量以及最近一次命令執行的時間。
介面說明
介面說明
建議您先呼叫該介面查詢執行個體的雲端助手狀態,當 CloudAssistantStatus 為 true 時再執行命令或下發檔案,尤其對於新購執行個體。
分頁查詢首頁時,僅需設定
MaxResults以限制回傳資訊的項目數,回傳結果中的NextToken將作為查詢後續頁的憑證。查詢後續頁時,將NextToken參數設定為上一次回傳結果中取得的NextToken作為查詢憑證,並設定MaxResults限制回傳項目數。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeCloudAssistantStatus |
get |
*Instance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
執行個體所在地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域清單。 |
cn-hangzhou |
| OSType |
string |
否 |
執行個體的作業系統類型。取值範圍:
|
Windows |
| PageNumber |
integer |
否 |
說明
該參數即將下線,建議您使用 NextToken 與 MaxResults 完成分頁查詢操作。 |
1 |
| PageSize |
integer |
否 |
說明
該參數即將下線,建議您使用 NextToken 與 MaxResults 完成分頁查詢操作。 |
10 |
| MaxResults |
integer |
否 |
分頁查詢時每頁的最大項目數。若已設定 InstanceId 參數,則該參數無效。 最大值為 50。 預設值為 10。 |
10 |
| NextToken |
string |
否 |
查詢憑證(Token),取值為上一次 API 呼叫返回的 NextToken 參數值。 |
AAAAAdDWBF2 |
| InstanceId |
array |
否 |
執行個體 ID 列表。 |
i-bp1iudwa5b1tqa**** |
|
string |
否 |
執行個體 ID 列表,可包含 ECS 執行個體 ID、託管執行個體 ID。 最多可指定 100 個執行個體 ID。 |
i-bp1iudwa5b1tqa**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| InstanceCloudAssistantStatusSet |
object |
||
| InstanceCloudAssistantStatus |
array<object> |
執行個體雲端助手安裝狀態結果集合。 |
|
|
object |
|||
| ActiveTaskCount |
integer |
執行個體內的雲端助手運行中的任務數。 |
0 |
| CloudAssistantStatus |
string |
執行個體內的雲端助手是否在運行中。可能值:
|
true |
| CloudAssistantVersion |
string |
雲端助手 Agent 版本號,若未安裝或未運行雲端助手 Agent,則該值為空。 |
2.2.0.106 |
| InstanceId |
string |
執行個體 ID。 |
i-bp1iudwa5b1tqa**** |
| InvocationCount |
integer |
執行個體內的雲端助手已完成的任務數。 |
2 |
| LastHeartbeatTime |
string |
雲端助手最近一次心跳時間。該值平均每分鐘(有上下 5 秒的隨機浮動,最短 55 秒,最長 65 秒)更新一次。格式為 ISO 8601,時區為 UTC。 |
2021-03-15T09:00:00Z |
| LastInvokedTime |
string |
最近一次命令執行的時間。格式為 ISO 8601,時區為 UTC。 |
2021-03-15T08:00:00Z |
| OSType |
string |
執行個體作業系統類型。可能值:
|
Linux |
| SupportSessionManager |
boolean |
執行個體內的雲端助手是否支援工作階段管理功能。若不支援,表示雲端助手版本較低,請將用戶端更新至最新版本。 雲端助手支援工作階段管理功能的最低版本如下:
|
true |
| NextToken |
string |
本次呼叫返回的查詢憑證值。 |
AAAAAdDWBF2 |
| PageNumber |
integer |
目前頁碼。 |
1 |
| PageSize |
integer |
每頁行數。 |
1 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
執行個體總個數。 說明
使用 MaxResults 和 NextToken 參數進行分頁查詢時,回傳的 TotalCount 參數值無意義。 |
1 |
樣本
正常返回樣本
JSON格式
{
"InstanceCloudAssistantStatusSet": {
"InstanceCloudAssistantStatus": [
{
"ActiveTaskCount": 0,
"CloudAssistantStatus": "true",
"CloudAssistantVersion": "2.2.0.106",
"InstanceId": "i-bp1iudwa5b1tqa****",
"InvocationCount": 2,
"LastHeartbeatTime": "2021-03-15T09:00:00Z",
"LastInvokedTime": "2021-03-15T08:00:00Z",
"OSType": "Linux",
"SupportSessionManager": true
}
]
},
"NextToken": "AAAAAdDWBF2",
"PageNumber": 1,
"PageSize": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支援呼叫 API。請檢查 RegionId 參數取值是否正確。 |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | 執行個體ID為空。 |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的參數 MaxResults 不合法。 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 傳送請求時發生錯誤,請稍後重試。 |
| 500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | |
| 403 | InvalidParameterCharacter | The specified parameter %s contains illegal characters. | |
| 403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | 目標執行個體數量超過上限。 |
| 403 | Operation.Forbidden | The operation is not permitted. | 該操作是不被允許的。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的 RegionId 不存在,請您檢查此產品在該地域是否可用。 |
| 404 | InvalidInstance.NotFound | The specified instance does not exist. | 指定的執行個體不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。