Installs Cloud Assistant Agent on one or more Elastic Compute Service (ECS) instances. After Cloud Assistant Agent is installed on ECS instances, you must restart the instances for Cloud Assistant Agent to take effect.

Usage notes

After you call the InstallCloudAssistant operation and then the RebootInstance operation, Cloud Assistant Agent takes effect.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes InstallCloudAssistant

The operation that you want to perform. Set the value to InstallCloudAssistant.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

InstanceId.N String Yes i-bp1iudwa5b1tqa****

The ID of instance N.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The request ID.


Sample requests
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "928E2273-5715-46B9-A730-238DC996A533"

Error codes

HTTP status code Error code Error message Description
400 RegionId.ApiNotSupported The api is not supported in this region. This operation cannot be performed in the specified region. Check whether the region ID is valid.
400 MissingParam.InstanceId The parameter instanceId is missing or empty. InstanceId.N is required.
403 InstanceIds.ExceedLimit The number of instance IDs exceeds the upper limit. The maximum number of instance IDs is exceeded.
403 Operation.Forbidden The operation is not permitted. The operation is not supported.
404 InvalidInstance.NotFound The specified instance does not exist. The specified instance is not found.
500 InternalError.Dispatch An error occurred when you dispatched the request. An error occurred while the request was being sent. Try again later.

For a list of error codes, see Service error codes.