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
Authorization information
There is currently no authorization information disclosed in the API.
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:
| 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
Examples
Sample success responses
JSON
format
{
"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