InstallCloudAssistant-阿里云帮助中心

Operation description

Usage notes

After you call the InstallCloudAssistant operation to install Cloud Assistant Agent on an ECS instance, call the RebootInstance operation to restart the instance to make the installation take effect.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:InstallCloudAssistant

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The IDs of instances. You can specify up to 50 instance IDs in a single request.	cn-hangzhou
RegionId	string	Yes	The IDs of instances. You can specify up to 50 instance IDs in a single request.	cn-hangzhou
InstanceId	array	Yes	The ID of the instance.	i-bp1iudwa5b1tqa****
	string	No	The request ID.	i-bp1iudwa5b1tqa****

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error response

JSON format

{
    "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.	The API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	The number of specified instance IDs exceeds the upper limit.
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
403	InvalidInstanceId.OSTypeUnsupported	The OS type of the instance %s corresponding to the parameter InstanceId does not support the operation.	The operating system type of the instance corresponding to the parameter InstanceId does not support this operation.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidInstance.NotFound	The specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.