Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Configuring a Cross-Region Backup Policy
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Configuring a Cross-Region Backup Policy

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

backup_policy

Yes

UpdateBackupOffsitePolicyInfo object

Definition

Backup policy information.

Constraints

N/A
Table 4 UpdateBackupOffsitePolicyInfo

Parameter

Mandatory

Type

Description

open_auto_backup

Yes

Boolean

Definition

Whether to enable cross-region full backup.

Constraints

N/A

Range

  • true: Cross-region full backup is enabled.

  • false: Cross-region full backup is disabled.

Default Value

N/A

open_incremental_backup

Yes

Boolean

Definition

Whether to enable cross-region incremental backup.

Constraints

N/A

Range

  • true: Cross-region incremental backup is enabled. This function can only be enabled when open_auto_backup is enabled.

  • false: Cross-region incremental backup is disabled.

Default Value

N/A

destination_project_id

Yes

String

Definition

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.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

destination_region

Yes

String

Definition

Destination region for the cross-region backup policy.

Constraints

N/A

Range

N/A

Default Value

N/A

keep_days

Yes

Integer

Definition

Backup retention days.

Constraints

N/A

Range

1–1825

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

result

String

Definition

Update results.

Range

N/A

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

Example Response

Status code: 200

Success.

{
  "result" : "success"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management