Enabling or Disabling Remote Backup

This API is used to enable or disable the remote backup function for Linux servers with WTP enabled.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

POST /v5/{project_id}/wtp/{host_id}/set-remote-backup

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
host_id	Yes	String	Server ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
remote_backup	Yes	Boolean	Definition Whether to enable remote backup. Constraints N/A Range true: Enable remote backup. You need to set backup_addr and backup_host_id. false: Disable remote backup. You do not need to set backup_addr or backup_host_id. Default Value false
backup_addr	No	String	Definition Remote backup address, which must contain the IP address and port number. Format: IP:Port Constraints N/A Range Length: 0 to 256 characters Default Value N/A
backup_host_id	No	String	Definition ID of the remote backup server. The entered remote backup server ID must be the ID of a running backup server. Constraints Use the ListBackupHostsInfo API to query the running remote backup server. In the response body of the ListBackupHostsInfo interface, the backup_host_id whose backup_host_status is 1 is the ID of the running remote backup server. Range Length: 0 to 256 characters Default Value N/A

Status code: 200

Request succeeded.

None

Enable or disable remote backup.

POST https://{endpoint}/v5/{project_id}/wtp/{host_id}/set-remote-backup

{
  "remote_backup" : false
}

None

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.