All Products
Search
Document Center

Hybrid Backup Recovery:InstallBackupClients

Last Updated:Nov 14, 2022

Installs a backup client on one or more Elastic Compute Service (ECS) instances.

Operation Description

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsobjectYes

The IDs of ECS instances. You can specify up to 20 IDs.

Response parameters

ParameterTypeDescriptionExample
object

The reponse body.

Codestring

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

200
Messagestring

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskIdstring

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

t-*********************
Successboolean

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
true
InstanceStatusesarray

The status of ECS instances.

object

The status of ECS instances.

ValidInstanceboolean

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

  • 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-0xi5w***v3j3bh2gj5
ErrorCodestring

The error code that is returned. Valid values:

  • If the value is empty, the request is successful.
  • InstanceNotExists: The ECS instance does not exist.
  • InstanceNotRunning: The ECS instance is not running.
  • CloudAssistNotRunningOnInstance: Cloud Assistant is unavailable.
InstanceNotExists

Example

Request example

http(s)://[Endpoint]/?Action=InstallBackupClients
&InstanceIds=["i-0xi5wj5*****v3j3bh2gj5"]
&<Common request parameters>

Normal return example

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 API error center.