Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Backup and Restoration/ Querying an Automated Backup Policy
Updated on 2025-08-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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

backup_policy

Object

Backup policy information.

For details, see Table 3.
Table 3 backup_policy field data structure description

Parameter

Type

Description

keep_days

Integer

Full backup retention days. Value: 1 to 732

Minimum value: 1

Maximum value: 732

start_time

String

Full backup time window. The creation of an automated backup 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.

  • 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.

period

String

Full backup period. 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.

Example value:

  • 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.
  • 1,2,3,4,5,6,7 indicates that an automated backup is performed every day from Monday to Sunday.
  • 1,3,5 indicates that an automated backup is performed on Monday, Wednesday, and Friday.

differential_period

Integer

Differential backup period. An automated differential backup will be performed on the specified minutes.

rate_limit

Integer

Upload speed at which data is uploaded to OBS. 0 MB/s indicates that the speed is not limited. The upload speed is related to the bandwidth.

prefetch_block

Integer

Number of prefetch pages from the modified pages in the disk table file during a differential backup. When modified pages are adjacent (for example, with a bulk data load), you can set this parameter to a large value. When modified pages are scattered (for example, random update), you can set this parameter to a small value. The default value is 64.

filesplit_size

Integer

This field has been deprecated.

file_split_size

Integer

Size by which full and differential backup files are split, in GB. The value is from 0 to 1024, but it must be a multiple of 4. The default value is 4. 0 indicates the size is not limited.

enable_standby_backup

Boolean

Whether to enable backup on a standby node.

  • true: This function is enabled.
  • false: This function is disabled.

Example Request

Querying an automated backup policy

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy

Example Response

Automated backup policy queried.

{
    "backup_policy": {
        "period": "1,2,3,4,5,6,7",
        "keep_days": 7,
        "start_time": "18:00-19:00",
        "differential_period": 30 ,
        "rate_limit": 75 ,
        "prefetch_block": 64 ,
        "file_split_size": 4 ,
        "enable_standby_backup" : false
    }
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration