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

Querying an Automated Backup Policy

Function

This API is used to query an automated backup policy. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/backups/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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

backup_policy

BackupPolicy object

Backup policy information.
Table 4 BackupPolicy

Parameter

Type

Description

keep_days

Integer

Backup retention days.

Value: 1 to 732

start_time

String

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

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

period

String

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

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

retention_num_backup_level1

Integer

Number of retained level-1 backups. This parameter is returned when level-1 backup is enabled.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the automated backup policy of a DB instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy

Example Response

Status code: 200

Success.

{
  "backup_policy" : {
    "keep_days" : "7,",
    "start_time" : "19:00-20:00",
    "period" : "1,2",
    "retention_num_backup_level1" : 1
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management