Configuring a Cross-Region Backup Policy

Function

This API is used to configure a cross-region backup policy. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
backup_policy	Yes	UpdateBackupOffsitePolicyInfo object	Backup policy information.

**Table 4** UpdateBackupOffsitePolicyInfo
Parameter	Mandatory	Type	Description
open_auto_backup	Yes	Boolean	Whether to enable cross-region full backup. true: Enable cross-region full backup. false: Disable cross-region full backup.
open_incremental_backup	Yes	Boolean	Whether to enable cross-region incremental backup. true: Enable cross-region incremental backup. This function can be enabled only when open_auto_backup is enabled. false: Disable cross-region incremental backup.
destination_project_id	Yes	String	Target project ID for the cross-region backup policy. Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
destination_region	Yes	String	Target region for the cross-region backup policy.
keep_days	Yes	Integer	Backup retention days. Value: 1 to 1825

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
result	String	Returned result.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Configuring a cross-region backup policy

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/offsite-policy

{
  "backup_policy" : {
    "open_auto_backup" : true,
    "open_incremental_backup" : false,
    "destination_project_id" : "fd710c89089a448aa2e666ab15817090",
    "destination_region" : "cn-north-7",
    "keep_days" : 1
  }
}