Adding or Modifying a Remote Backup Server

Function

This API is used to add or modify a remote backup server.

Authorization Information

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.

URI

PUT /v5/{project_id}/wtp/backup-hosts

**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

**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.

Request Parameters

**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
host_id	Yes	String	Definition ID of the remote backup server. If the backup server does not exist, it will be added. If the backup server exists, it will be modified. Constraints N/A Range Length: 0 to 256 characters Default Value N/A
backup_host_ip	Yes	String	Definition Backup server IP address Constraints N/A Range Length: 0 to 256 characters Default Value N/A
backup_host_port	Yes	Integer	Definition Backup server port Constraints N/A Range Minimum value: 0; maximum value: 65535Default ValueN/A
backup_dir	Yes	String	Definition Backup path Constraints N/A Range Length: 0 to 256 characters Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Add or modify a remote backup server.

PUT https://{endpoint}/v5/{project_id}/wtp/backup-hosts

{
  "host_id" : "96ae7317-b5c4-4bc8-aa90-eda53f23e99e",
  "backup_host_ip" : "192.168.1.1",
  "backup_host_port" : 32,
  "backup_dir" : "/back"
}