Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Backup Management/ Modifying an Automated Backup Policy
Updated on 2023-10-18 GMT+08:00
View PDF

Modifying an Automated Backup Policy

Function

This API is used to modify an automated 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.

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 parameters

Parameter

Mandatory

Type

Description

backup_policy

Yes

MysqlBackupPolicy object

Database information.
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 value:

21:00-22:00

keep_days

Yes

Integer

Backup retention days.

Value: 1 to 732

period

Yes

String

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

Value range: The value is a number separated by commas (,), indicating the days of the week.

For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.

retention_num_backup_level1

No

Integer

Number of retained level-1 backups. The default value is 0.

  • This parameter is mandatory when the level-1 backup function is enabled.

    Value:

    • 0
    • 1
  • This parameter is unavailable when the level-1 backup function is disabled.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

status

String

Status.

Value:

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

instance_id

String

Instance ID.

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