Help Center/ GaussDB/ API Reference/ Historical APIs/ Backup Management/ Configuring an Automated Backup Policy

Updated on 2024-10-28 GMT+08:00

View PDF

Configuring an Automated Backup Policy

Function

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

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

PUT 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 value, 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

**Table 2** Parameter description
Name	Mandatory	Type	Description
backup_policy	Yes	Object	Backup policy information. For details, see Table 3.

**Table 3** backup_policy field data structure description
Name	Mandatory	Type	Description
keep_days	Yes	Integer	Backup retention days. The value ranges from 1 to 36500.
start_time	Yes	String	Backup time window. The creation of an automated backup 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 value of HH must be 1 greater than the value of hh. The values of mm and MM must be the same and must be 00. Example value: 21:00-22:00 NOTE: This parameter indicates the time period (in UTC format) during which backup is performed. For example, if the local backup time is 05:00-06:00 and the time zone is UTC+08:00, set the parameter value to 21:00-22:00. If the time zone is UTC+04:00, set the value to 01:00-02:00.
period	Yes	String	Full backup period. An automated full backup is performed on the UTC date of each week. Value range: 1 to 7. 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. NOTE: This parameter indicates the date (in UTC format) on which backup is performed. For example, if the local backup time is 05:00-06:00 on Monday and Tuesday, and the time zone is UTC+08:00, set the parameter value to 1,7. If the time zone is UTC+04:00, set the value to 1,2.
differential_period	Yes	String	Differential backup interval. Interval for automated differential backup. Its value can be 15, 30, 60, 180, 360, 720, or 1440. The unit is minute. Example value: 30
rate_limit	No	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. Value range: 0-1024 Minimum value: 0 MB/s
prefetch_block	No	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. Value: 1 to 8192 Minimum value: 1. Maximum value: 8192
file_split_size	No	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. Value range: 0-1024 Minimum value: 0 Maximum value: 1024
filesplit_size	No	Integer	Size by which full and differential backup files are split. Deprecated field. Leave it blank.
enable_standby_backup	No	Boolean	Whether to enable backup on a standby node. (It is not suitable for single-node instances and instances earlier than 3.100.0.)

Response Parameters

None

Example Request

Configuring a backup policy for GaussDB (Set backup retention period to seven days and backup time window to 19:00-20:00)

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy
{
         "backup_policy": {
                "keep_days": 7,
                "start_time": "19:00-20:00",
                "period": "1,2,3,4,5",
                "differential_period": "30",
                "rate_limit": 75 ,
                "prefetch_block": 64 ,
                "file_split_size": 4 ,
                "enable_standby_backup" : false
 
 
 
 
 
 }
}