Batch Deploy Backup Clients on ECS with CreateClients API - Cloud Backup - Alibaba Cloud - Cloud Backup

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of Cloud Backup. For more information, see Billing methods and billable items.

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

hbr:CreateClients

create

*All Resource

*

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 in the same way as 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: true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzvx7d3c4kpny
CrossAccountType	string	No	The backup type. 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	integer	No	The ID of the source Alibaba Cloud account that authorizes the current account to perform cross-account backup.	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 account for cross-account backup.	hbrcrossrole

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. A value of 200 indicates a successful call.	200
Message	string	The returned message. "successful" is returned for a successful call. Otherwise, an error message is returned.	successful
RequestId	string	The request ID.	4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskId	string	The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.	t-000h9x5t02vhyksf1x7k
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
InstanceStatuses	object
InstanceStatus	array<object>	The status of the ECS instance. If you specify multiple instance IDs in the request and an ECS instance does not meet the requirements for HBR client installation, an error message is returned based on this parameter.
	object	The status of the ECS instance. If you specify multiple instance IDs in the request and an ECS instance does not meet the requirements for HBR client installation, an error message is returned based on this parameter.
ValidInstance	boolean	Indicates whether the HBR client can be installed on the ECS instance. Valid values: true: The HBR client can be installed on the ECS instance. false: The HBR client cannot be installed on the ECS instance.	true
InstanceId	string	The ECS instance ID.	i-2zegp3cdu******uj9i

Examples

Success response

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.