Queries whether the Cloud Assistant client is installed on one or more Elastic Compute Service (ECS) instances. If the Cloud Assistant client is installed, the system queries the total number of Cloud Assistant commands that have been run, the number of Cloud Assistant commands that are being run, and the time when Cloud Assistant commands were last run.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCloudAssistantStatus |
The operation that you want to perform. Set the value to DescribeCloudAssistantStatus. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
OSType | String | No | Windows |
The operating system type of the instance. Valid values:
|
PageNumber | Long | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Long | No | 10 |
The number of entries to return on each page. Maximum value: 100. Default value: 10. |
InstanceId.N | String | No | i-bp1iudwa5b1tqa**** |
The ID of instance N. You can specify up to 100 instance IDs in each request. Valid values of N: 1 to 100. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageSize | Long | 1 |
The number of entries returned per page. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
The ID of the request. |
PageNumber | Long | 1 |
The page number of the returned page. |
TotalCount | Long | 1 |
The total number of instances. |
InstanceCloudAssistantStatusSet | Array of InstanceCloudAssistantStatus |
Details about the installation status of the Cloud Assistant client. |
|
InstanceCloudAssistantStatus | |||
CloudAssistantStatus | String | true |
Indicates whether the Cloud Assistant client is installed on the instance. |
LastInvokedTime | String | 2021-03-15T08:00:00Z |
The time when commands were last run. |
CloudAssistantVersion | String | 2.2.0.106 |
The version number of the Cloud Assistant client. |
ActiveTaskCount | Long | 0 |
The number of commands that are being run. |
InvocationCount | Long | 2 |
The total number of commands that have been run. |
InstanceId | String | i-bp1iudwa5b1tqa**** |
The ID of the instance. |
LastHeartbeatTime | String | 2021-03-15T09:00:00Z |
The last heartbeat time of Cloud Assistant. |
OSType | String | Linux |
The operating system type of the instance. Valid values:
|
SupportSessionManager | Boolean | true |
Indicates whether the version of the Cloud Assistant client supports the session management feature. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=DescribeCloudAssistantStatus
&InstanceId.1=i-bp1iudwa5b1tqa****
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
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
format
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"
} ]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | RegionId.ApiNotSupported | The api is not supported in this region. | The error message returned because the API operation cannot be called in the specified region. Check whether the RegionId parameter is valid. |
403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | The error message returned because the number of specified instance IDs exceeds the upper limit. |
403 | InvalidParam.PageSize | The specified parameter is invalid. | The error message returned because the specified PageSize parameter is invalid. |
403 | InvalidParam.PageNumber | The specified parameter is invalid. | The error message returned because the specified PageNumber parameter is invalid. |
403 | Operation.Forbidden | The operation is not permitted. | The error message returned because the operation is not supported. |
404 | InvalidInstance.NotFound | The specified instance does not exist. | The error message returned because the specified instance does not exist. |
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | The error message returned because an error occurred when the request was being sent. Try again later. |
For a list of error codes, visit the API Error Center.