Call the InstallCloudAssistant operation to install the cloud assistant Agent for one or multiple specified ECS instances.

Usage notes

After installing the cloud assistant Agent by calling this operation, you need to call the RebootInstances operation to restart the instance. Then, the Agent can take effect.

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: InstallCloudAssistant

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

Version string required Sample value: 2020-04-01

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

InstanceIds.N string[] required Sample value: InstanceIds.1=i-ervasv*****&InstanceIds.2=i-uihrdgh*****

The instance ID. Up to 50 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 &.

Response parameters

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

InstallingInstanceIds string[] Sample value: \["i-ycm4ru8\*\*\*\*","iyclwwbhbls\*\*\*\*" \]

The ID of an instance for which the Agent installation request is submitted.

FailedInstances object[] Sample value: --

The information about the instance for which the installation failed, and that meets the condition.

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

The ID of the instance for which the installation fails.

ErrorMessage string Sample value: --

The failure information.

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	MissingParameter.InstanceIds	The required parameter InstanceIds is not supplied.	The instance ID cannot be empty.
400	LimitExceeded.MaximumInstanceIds	The specified InstanceIds exceeds the limit.	The number of instances exceeds the limit.
400	InvalidInstanceIds.Conflict	InvalidInstanceIds.Conflict	Duplicate instance IDs are passed in
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service