Call the DescribeCloudAssistantStatus operation to query the installation status of the cloud assistant Agent on one or multiple instances.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: DescribeCloudAssistantStatus

The action that you want to perform. Value: DescribeCloudAssistantStatus.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

InstanceIds.N string[] Optional Sample value: InstanceIds.1=i-sdvgs****

The instance ID. A maximum of 100 instance IDs are supported. You can call the DescribeInstances operation to query and obtain the instance ID.

Argument - N: specifies the serial number of the instance.

Separate multiple instance IDs with &.

OSType string Optional Sample value: linux

The operating system type. Value:

linux: The instance runs on the Linux operating system.

windows: The instance runs on the Windows operating system.

ClientVersion string Optional Sample value: v1.9.0

The Agent version.

Status string Optional Sample value: Running

The Agent status. Valid values:

Running: The Agent is running.

Updating: The Agent is being upgraded.

Error: An error occurred.

Lost: Heartbeat times out.

ReadyReboot: To be restarted.

InstallFailed: Installation failure.

Uninstalling: The Agent is being uninstalled.

Initializing: The Agent is being initialized.

PageNumber integer Optional Sample value: 1

The current page number.

Starting value: 1.

Default value: 1

PageSize integer Optional Sample value: 10

The number of entries returned on each page in a pagination query.

Value range: 1–100.

Default value: 10.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

PageNumber integer Sample value: 1

The current page number.

PageSize integer Sample value: 10

The number of entries returned on each page in a pagination query.

TotalCount integer Sample value: 100

The total number of instances with Agent installed.

Instances object[] Sample value: --

The information about instances that meet the conditions.

InstanceId string Sample value: i-yci89z1gpml8j1\*\*\*\*

The instance ID.

InstanceName string Sample value: instance-3

The instance name.

OSType string Sample value: linux

The operating system type.

OSVersion string Sample value: CentOS 7.9 64 bit

The operating system version.

HostName string Sample value: iv-yci89z1gpml8j1\*\*\*\*

The host name.

LastHeartbeatTime string Sample value: 2023-07-01T09:00:45Z

The time the last heartbeat packet is received (last online time).

Status string Sample value: Running

The Agent status.

ClientVersion string Sample value: v1.1.0

The Agent version.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	The user ID cannot be empty.
400	InvalidOSType.Malformed	The specified OSType is malformed.	The specified operating system type is invalid.
400	InvalidStatus.Malformed	The specified Status is malformed.	The specified Agent status is invalid.
400	InvalidClientVersion.Malformed	The specified ClientVersion is malformed.	The specified Agent version is invalid.
400	LimitExceeded.MaximumInstanceIds	The specified InstanceIds exceeds the limit.	The number of instances exceeds the limit.
400	InvalidRegion	Service [ecs] is not available in region [ap-guangzhou].	The specified region is invalid
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service