Installs one or more Cloud Backup clients on specified instances.
Operation description
Before you call this operation, make sure that you fully understand the billing methods and pricing of Cloud Backup. For more information, see Billing methods and billable items.
Debugging
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:CreateClients | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
VaultId | string | Yes | The ID of the backup vault. | v-0001ufe******kgm |
AlertSetting | string | No | The alert settings. Valid value: INHERITED, which indicates that the HBR client sends alert notifications by using the same method configured for the backup vault. | INHERITED |
ClientInfo | string | No | The installation information of the HBR clients. | [ { "instanceId": "i-bp116lr******te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q******9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux******hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }] |
UseHttps | boolean | No | Specifies whether to transmit data over HTTPS. Valid values:
| false |
ResourceGroupId | string | No | The ID of the resource group. | rg-aekzvx7d3c4kpny |
CrossAccountType | string | No | The backup type. 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. | 158975xxxxx4625 |
CrossAccountRoleName | string | No | The name of the Resource Access Management (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. | hbrcrossrole |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "200",
"Message": "successful",
"RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
"TaskId": "t-000h9x5t02vhyksf1x7k",
"Success": true,
"InstanceStatuses": {
"InstanceStatus": [
{
"ValidInstance": true,
"InstanceId": "i-2zegp3cdu******uj9i"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-05-22 | The request parameters of the API has changed | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |