DescribeCloudAssistantStatus - 云服务器 ECS

接口说明

建议您先调用该接口查询实例的云助手状态，当CloudAssistantStatus为true时再执行命令或下发文件，尤其对于新购实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCloudAssistantStatus	系统规定参数。取值：DescribeCloudAssistantStatus。
RegionId	String	是	cn-hangzhou	实例所在地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
OSType	String	否	Windows	实例的操作系统类型。取值范围： Windows。 Linux。
PageNumber	Long	否	1	当前页码。起始值为1。默认值为1。
PageSize	Long	否	10	分页查询时设置的每页行数。若已设置InstanceId参数，则该参数无效。最大值为50。默认值为10。
InstanceId.N	String	否	i-bp1iudwa5b1tqa****	实例ID列表，可包含ECS实例ID、托管实例ID。最多可指定100个实例ID。

返回数据


名称	类型	示例值	描述
PageSize	Long	1	每页行数。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
PageNumber	Long	1	当前页码。
TotalCount	Long	1	实例总个数。
InstanceCloudAssistantStatusSet	Array of InstanceCloudAssistantStatus		实例云助手安装状态结果集合。
InstanceCloudAssistantStatus
CloudAssistantStatus	String	true	实例内的云助手是否在运行中。可能值： true：2分钟内有心跳。 false：2分钟内无心跳。
LastInvokedTime	String	2021-03-15T08:00:00Z	最近一次命令执行的时间。
CloudAssistantVersion	String	2.2.0.106	云助手Agent版本号，若未安装或未运行云助手Agent，则该值为空。
ActiveTaskCount	Long	0	实例内的云助手运行中的任务数。
InvocationCount	Long	2	实例内的云助手已完成的任务数。
InstanceId	String	i-bp1iudwa5b1tqa****	实例ID。
LastHeartbeatTime	String	2021-03-15T09:00:00Z	云助手最近一次心跳时间。该值平均每分钟（有上下5秒的随机浮动，最短55秒，最长65秒）更新一次。
OSType	String	Linux	实例操作系统类型。可能值： Windows。 Linux。
SupportSessionManager	Boolean	true	实例内的云助手是否支持会话管理功能。若不支持，表示云助手版本较低，请将客户端更新至最新版本。云助手支持会话管理功能的最低版本如下： Linux：2.2.3.189 Windows：2.1.3.189

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeCloudAssistantStatus
&InstanceId.1=i-bp1iudwa5b1tqa****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCloudAssistantStatusResponse>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
    <InstanceCloudAssistantStatusSet>
        <InstanceCloudAssistantStatus>
            <CloudAssistantVersion>2.2.0.106</CloudAssistantVersion>
            <SupportSessionManager>true</SupportSessionManager>
            <InstanceId>i-bp1iudwa5b1tqa****</InstanceId>
            <CloudAssistantStatus>true</CloudAssistantStatus>
            <OSType>Linux</OSType>
            <InvocationCount>2</InvocationCount>
            <ActiveTaskCount>0</ActiveTaskCount>
            <LastInvokedTime>2021-03-15T08:00:00Z</LastInvokedTime>
            <LastHeartbeatTime>2021-03-15T09:00:00Z</LastHeartbeatTime>
        </InstanceCloudAssistantStatus>
    </InstanceCloudAssistantStatusSet>
</DescribeCloudAssistantStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码


HttpCode	错误码	错误信息	描述
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.	指定的 PageSize 参数无效。
400	InvalidParam.PageNumber	The specified parameter is invalid.	指定的 PageNumber 参数无效。
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	目标实例数量超过上限。
403	Operation.Forbidden	The operation is not permitted.	该操作是不被允许的。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
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.	请求后端超时。

访问错误中心查看更多错误码。