InstallBackupClients - Cloud Backup - Alibaba Cloud Documentation Center

Installs an HBR client on one or more Elastic Compute Service (ECS) instances.

Operation description

This operation creates an asynchronous job at the backend and calls Cloud Assistant to install an HBR client on an ECS instance.
You can call the DescribeTask operation to query the execution result of an asynchronous job.
The timeout period of an asynchronous job is 15 minutes. We recommend that you call the DescribeTask operation to run the first query 60 seconds after you call the InstallBackupClients operation to install HBR clients. Then, run the next queries at an interval of 30 seconds.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hbr:InstallBackupClients		All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	object	Yes	The IDs of the ECS instances. You can specify up to 20 IDs.	["i-0xi5wj5*****v3j3bh2gj5"]
CrossAccountType	string	No	Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	long	No	The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	16392782xxxxxx
CrossAccountRoleName	string	No	The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	BackupRole

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.	t-*********************
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
InstanceStatuses	array<object>	The status of the ECS instance.
	object
ValidInstance	boolean	Indicates whether an HBR client can be installed on the ECS instance. Valid values: true: An HBR client can be installed on the ECS instance. false: An HBR client cannot be installed on the ECS instance.	true
InstanceId	string	The ID of the ECS instance.	i-0xi5w***v3j3bh2gj5
ErrorCode	string	The error code that is returned. Valid values: If the value is empty, the call is successful. InstanceNotExists: The ECS instance does not exist. InstanceNotRunning: The ECS instance is not running. CloudAssistNotRunningOnInstance: Cloud Assistant is unavailable.	InstanceNotExists

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history