Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Backup Management/ Configuring a Same-Region Backup Policy
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Configuring a Same-Region Backup Policy

Function

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

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update

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.

It can be obtained by calling the IAM API used to obtain a user token.

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

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

backup_policy

Yes

MysqlBackupPolicy object

Database backup policy.
Table 4 MysqlBackupPolicy

Parameter

Mandatory

Type

Description

start_time

Yes

String

Backup time window. Automated backups will be triggered during the backup time window.

The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.

  • The HH value must be 1 greater than the hh value.
  • The values of mm and MM must be the same and must be set to 00.

Example: 21:00–22:00

keep_days

Yes

Integer

Backup retention days. Value range: 1–732.

You can also contact customer service to extend the retention period to 3,660 days.

period

Yes

String

Backup cycle configuration. Data will be automatically backed up on the selected days every week.

The value is a list of numbers separated by commas (,), where each number plus one represents a day of the week for automatic backups.

For example, 1,2,3,4,5,6,7 indicates that data is backed up every day from Tuesday to Monday.

retention_num_backup_level1

No

Integer

Number of retained level-1 backups. The value can be 0 or 1. The default value is 0. This parameter is required only when the level-1 backup function is enabled.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

status

String

Status information. Values:

  • BUILDING: Modification in progress
  • COMPLETED: Modification completed
  • FAILED: Modification failed

instance_id

String

Instance ID, which is compliant with the UUID format.

instance_name

String

Instance name.

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

Modifying the automated backup policy of the DB instance (Data is backed up from 19:00 to 20:00 every Monday to Friday. Backup files are stored for seven days.)

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update
{
  "backup_policy" : {
    "keep_days" : 7,
    "start_time" : "19:00-20:00",
    "period" : "1,2,3,4,5"
  }
}

Example Response

Status code: 200

Success.

{
  "status" : "COMPLETED",
  "instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
  "instance_name" : "gauss-mysql"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management