All Products
Search
Document Center

Hybrid Backup Recovery:CreateClients

Last Updated:Nov 14, 2022

Installs one or more HBR backup clients on specified instances.

Operation Description

Before you call this operation, make sure that you fully understand the billing methods and pricing of Hybrid Backup Recovery (HBR). For more information, see Billable items and billing methods.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0001ufe******kgm
AlertSettingstringNo

The alert settings. Valid value: INHERITED, which indicates that the backup client sends alert notifications in the same way as the backup vault.

INHERITED
ClientInfostringNo

The installation information of the backup clients.

[ { "instanceId": "i-bp116lr******te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q******9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux******hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttpsbooleanNo

Specifies whether to transmit data over HTTPS. Valid values:

  • true: transmits data over HTTPS.
  • false: transmits data over HTTP.
false
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekzvx7d3c4kpny

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskIdstring

The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.

t-000h9x5t02vhyksf1x7k
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
InstanceStatusesarray

The status of the ECS instance.

If the status of an ECS instance cannot meet the requirements to install a backup client and the value of the InstanceIds parameter is greater than 1, an error message is returned based on the value of this parameter.

object

The status of the ECS instance.

If the status of an ECS instance cannot meet the requirements to install a backup client and the value of the InstanceIds parameter is greater than 1, an error message is returned based on the value of this parameter.

ValidInstanceboolean

Indicates whether a backup client can be installed on the ECS instance. Valid values: Valid values:

  • true: A backup client can be installed on the ECS instance.
  • false: A backup client cannot be installed on the ECS instance.
true
InstanceIdstring

The ID of the ECS instance.

i-2zegp3cdu******uj9i

Example

Request example

http(s)://[Endpoint]/?Action=CreateClients
&VaultId=v-0001ufe******kgm
&AlertSetting=INHERITED
&ClientInfo=[  {    "instanceId": "i-bp116lr******te9q2",    "accessKeyId": "",    "accessKeySecret": "",    "clusterId": "cl-000csy09q******9rfz9",    "sourceTypes": [      "HANA"    ]  },  {    "instanceId": "i-bp116lrux******hte9q4",    "accessKeyId": "",    "accessKeySecret": "",    "clusterId": "cl-000csy09q5094vw9rfz9",    "sourceTypes": [      "HANA"    ]  }]
&UseHttps=false
&ResourceGroupId=rg-aekzvx7d3c4kpny
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-2zegp3cdu******uj9i"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.