調(diào)用DescribeCloudAssistantStatus查詢一臺或者多臺實例是否安裝了云助手Agent。如果已安裝了云助手，還將查詢云助手命令執(zhí)行的總數(shù)量、正在執(zhí)行的數(shù)量以及最近一次命令執(zhí)行的時間。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeCloudAssistantStatus | get | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 實例所在地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| OSType | string | 否 | 實例的操作系統(tǒng)類型。取值范圍：
| Windows |
| PageNumber | long | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
| PageSize | long | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 10 |
| MaxResults | integer | 否 | 分頁查詢時每頁的最大條目數(shù)。若已設(shè)置 InstanceId 參數(shù)，則該參數(shù)無效。 最大值為 50。 默認值為 10。 | 10 |
| NextToken | string | 否 | 查詢憑證（Token），取值為上一次 API 調(diào)用返回的 NextToken 參數(shù)值。 | AAAAAdDWBF2 |
| InstanceId | array | 否 | 實例 ID 列表。 | |
| string | 否 | 實例 ID 列表，可包含 ECS 實例 ID、托管實例 ID。 最多可指定 100 個實例 ID。 | i-bp1iudwa5b1tqa**** |
返回參數(shù)
示例
正常返回示例
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. | 指定地域下不支持調(diào)用 API。請檢查 RegionId 參數(shù)取值是否正確。 |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | 實例ID為空。 |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 參數(shù)無效。 |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的 PageNumber 參數(shù)無效。 |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的參數(shù)NextToken不合法。 |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的參數(shù)MaxResults不合法。 |
| 403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | 目標實例數(shù)量超過上限。 |
| 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. | 指定的實例不存在。 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 發(fā)送請求時發(fā)生錯誤，請稍后重試。 |
| 500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求后端超時，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-21 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-05-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-08-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-08-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |