调用DescribeCloudAssistantStatus查询一台或者多台实例是否安装了云助手Agent。如果已安装了云助手，还将查询云助手命令执行的总数量、正在执行的数量以及最近一次命令执行的时间。
接口说明
接口说明
建议您先调用该接口查询实例的云助手状态，当 CloudAssistantStatus 为 true 时再执行命令或下发文件，尤其对于新购实例。
分页查询首页时，仅需设置
MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeCloudAssistantStatus |
get |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| 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 |
|||
| 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 |
| 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 |
实例操作系统类型。可能值：
|
Linux |
| SupportSessionManager |
boolean |
实例内的云助手是否支持会话管理功能。若不支持，表示云助手版本较低，请将客户端更新至最新版本。 云助手支持会话管理功能的最低版本如下：
|
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. | 指定的实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。