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

Description

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

Debugging

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 ECS instance. You can call the DescribeRegions operation to query the most recent region list.

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

The ID of ECS instance N. Valid values of N: 1 to 50.

Response parameters

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

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=InstallCloudAssistant
&InstanceId.1=i-bp11f7trr4hbi1****
&InstanceId.2=i-bp1iudwa5b1tqa****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

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

<InstallCloudAssistantResponse>
    <RequestId>928E2273-5715-46B9-A730-238DC996A533</RequestId>
</InstallCloudAssistantResponse>

JSON format 

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

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

Error codes

HttpCode 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 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 InstanceId parameter 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.