Setting an Automated Backup Policy

Description

This API is used to set an automated backup policy.

URI

• URI format

  PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

• URI example

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

Request Parameters

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  backup_policy	Object	Yes	The backup policy object, including the backup retention period (days) and start time. For more information, see Table 3.

  Table 3 Data structure description of the backup_policy field

  Name	Type	Mandatory	Description
  keep_days	String	No	The number of days to retain the generated backup files. Either keep_days or enable_incremental_backup must be transferred. The value ranges from 0 to 732. If the value is 0, backup policies are disabled, including automated and incremental backup policies.
  start_time	String	No	The backup time window. Automated backups will be triggered during the backup time window. This parameter is mandatory if the automated backup policy is enabled. This parameter is not transferred if the automated backup policy is disabled. 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. Example value: 23:00-00:00
  period	String	No	The backup cycle configuration. Data will be automatically backed up on the selected days every week. Value range: The value is a list of digits separated by commas (,). Each digit indicates a day of the week. The restrictions on the backup retention period are as follows: This parameter is not transferred if the retention period is set to 0. If you set the retention period to 1 to 6 days, data is automatically backed up each day of the week. Set the parameter value to 1,2,3,4,5,6,7. If you set the retention period to 7 to 732 days, select at least one day of the week for the backup cycle. Example value: 1,2,3,4
  enable_incremental_backup	Boolean	No	Whether to enable incremental backup. If this parameter is not transferred, the incremental backup status remains unchanged. After incremental backup is enabled, the system automatically performs an incremental backup. The values and constraints of incremental backup are as follows: false: Incremental backup is disabled. If incremental backup is disabled, the previous incremental backups will be deleted. true: Incremental backup is enabled. After incremental backup is enabled, a full backup is triggered.

Example Request

• Enabling or modifying the automated backup policy and enabling the incremental backup policy:

  PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
  
   { 
     "backup_policy" : { 
       "keep_days" : 9, 
       "start_time" : "08:15-09:15", 
       "period" : "1,4,5,6,7", 
       "enable_incremental_backup" : true 
     } 
   }

• Enabling or modifying the automated backup policy and disabling the incremental backup policy:

  PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
  
   { 
     "backup_policy" : { 
       "keep_days" : 9, 
       "start_time" : "08:15-09:15", 
       "period" : "1,4,5,6,7", 
       "enable_incremental_backup" : false 
     } 
   }

• Enabling or modifying the automated backup policy only, and retaining the status of the incremental backup policy:

  PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
  
   { 
     "backup_policy" : { 
       "keep_days" : 9, 
       "start_time" : "08:15-09:15", 
       "period" : "1,4,5,6,7" 
     } 
   }

• Enabling the incremental backup policy: This request can be delivered only when the automated full backup policy is enabled. The same rule applies to disabling the incremental backup policy.

  PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
  
   { 
     "backup_policy" : { 
       "enable_incremental_backup" : true 
     } 
   }

• Disabling backup policies, including automated and incremental backup policies:

  PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
  
   { 
     "backup_policy" : { 
       "keep_days" : 0 
     } 
   }

Response Parameters

None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.