幫助中心
首頁 Elastic Compute Service 開發參考 API參考 API目錄 雲助手 DescribeCloudAssistantStatus - 查詢雲助手安裝狀態

DescribeCloudAssistantStatus - 查詢雲助手安裝狀態

更新時間：
Copy as MD
產品

調用DescribeCloudAssistantStatus查詢一台或者多台執行個體是否安裝了雲助手Agent。如果已安裝了雲助手，還將查詢雲助手命令執行的總數量、正在執行的數量以及最近一次命令執行的時間。

介面說明

介面說明

  • 建議您先調用該介面查詢執行個體的雲助手狀態，當 CloudAssistantStatus 為 true 時再執行命令或下發檔案，尤其對於新購執行個體。

  • 分頁查詢首頁時，僅需設定MaxResults以限制返回資訊的條目數，返回結果中的NextToken將作為查詢後續頁的憑證。查詢後續頁時，將NextToken參數設定為上一次返回結果中擷取到的NextToken作為查詢憑證，並設定MaxResults限制返回條目數。

調試

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

調試

授權資訊

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

  • 操作：是指具體的許可權點。

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

    • 對於必選的資源類型，用前面加 * 表示。

    • 對於不支援資源級授權的操作，用全部資源表示。

  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeCloudAssistantStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

 無 無

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

執行個體所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

cn-hangzhou
RegionId

string

是

執行個體所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

cn-hangzhou
OSType

string

否

執行個體的作業系統類型。取值範圍：

  • Windows。

  • Linux。

  • FreeBSD。

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

PageSize

integer

每頁行數。

1
RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber

integer

當前頁碼。

1
TotalCount

integer

執行個體總個數。

1
NextToken

string

本次調用返回的查詢憑證值。

AAAAAdDWBF2
InstanceCloudAssistantStatusSet

object

InstanceCloudAssistantStatus

array<object>

執行個體雲助手安裝狀態結果集合。

object

CloudAssistantStatus

string

執行個體內的雲助手是否在運行中。可能值：

  • true：2 分鐘內有心跳。

  • false：2 分鐘內無心跳。

true
LastInvokedTime

string

最近一次命令執行的時間。

2021-03-15T08:00:00Z
CloudAssistantVersion

string

雲助手 Agent 版本號碼，若未安裝或未運行雲助手 Agent，則該值為空白。

2.2.0.106
ActiveTaskCount

integer

執行個體內的雲助手運行中的任務數。

0
InvocationCount

integer

執行個體內的雲助手已完成的任務數。

2
InstanceId

string

執行個體 ID。

i-bp1iudwa5b1tqa****
LastHeartbeatTime

string

雲助手最近一次心跳時間。該值平均每分鐘（有上下 5 秒的隨機浮動，最短 55 秒，最長 65 秒）更新一次。

2021-03-15T09:00:00Z
OSType

string

執行個體作業系統類型。可能值：

  • Windows。

  • Linux。

  • FreeBSD。

Linux
SupportSessionManager

boolean

執行個體內的雲助手是否支援會話管理功能。若不支援，表示雲助手版本較低，請將用戶端更新至最新版本。

雲助手支援會話管理功能的最低版本如下：

  • Linux：2.2.3.189

  • Windows：2.1.3.189

true

樣本

正常返回樣本

JSON格式

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstanceCloudAssistantStatusSet": {
    "InstanceCloudAssistantStatus": [
      {
        "CloudAssistantStatus": "true",
        "LastInvokedTime": "2021-03-15T08:00:00Z",
        "CloudAssistantVersion": "2.2.0.106",
        "ActiveTaskCount": 0,
        "InvocationCount": 2,
        "InstanceId": "i-bp1iudwa5b1tqa****",
        "LastHeartbeatTime": "2021-03-15T09:00:00Z",
        "OSType": "Linux",
        "SupportSessionManager": true
      }
    ]
  }
}

錯誤碼

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. 指定的參數NextToken不合法。
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 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. 地區資訊錯誤
404 InvalidInstance.NotFound The specified instance does not exist. 指定的執行個體不存在。

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

變更歷史

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

上一篇：DescribeSendFileResults下一篇：InstallCloudAssistant - 為執行個體安裝雲助手Agent