Querying an Automated Backup Policy

Description

This API is used to query an automated backup policy.

URI

URI format
GET 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 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	Explanation: User token obtained from IAM. For details, see Authentication. Constraints: N/A Value range: N/A Default value: N/A
project_id	string	path	Yes	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	string	path	Yes	Explanation: Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints: N/A Value range: N/A Default value: N/A

Example request

Enabling backup policies, including automated and incremental backup policies:

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
 { 
   "backup_policy" : { 
     "keep_days" : 7, 
     "start_time" : "19:00-20:00", 
     "period" : "1,2,4,5,6", 
     "enable_incremental_backup" : true 
   } 
 }

Enabling an automated backup policy but disabling an incremental backup policy:

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
 { 
   "backup_policy" : { 
     "keep_days" : 7, 
     "start_time" : "19:00-20:00", 
     "period" : "1,2,4,5,6", 
     "enable_incremental_backup" : false 
   } 
 }

Disabling backup policies, including automated and incremental backup policies:

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

Response 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** backup_policy field data structure description
Name	Type	Mandatory	Description
keep_days	Integer	Yes	The number of days to retain the backup files.
start_time	String	No	The backup time window. Automated backups will be triggered during the backup time window.
period	String	No	The backup cycle configuration. Data will be automatically backed up on the selected days every week.
enable_incremental_backup	Boolean	No	Whether to enable incremental backup. true: The incremental backup policy is enabled. false: The incremental backup policy is disabled.

Response example

Status code: 200

Success.

{    "backup_policy" : {  
       "keep_days" : 7, 
       "start_time" : "19:00-20:00", 
       "period" : "1,2,4,5,6",  
       "enable_incremental_backup" : true 
   } 
 }

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.