Querying an Automated Backup Policy

Function

This API is used to query an automated backup policy.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:getBackupPolicy	read	-	-	dds:instance:list dds:backup:list	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/backups/policy
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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 Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 3** Response body parameters
Name	Mandatory	Type	Description
backup_policy	Yes	Object	Definition The backup policy object, including the backup retention period (days) and start time. For more information, see Table 4. Range N/A

**Table 4** backup_policy field data structure description
Name	Mandatory	Type	Description
keep_days	Yes	Integer	Definition The number of days to retain the backup files. Range N/A
start_time	No	String	Definition The backup time window. Automated backups will be triggered during the backup time window. Range N/A
period	No	String	Definition The backup cycle configuration. Data will be automatically backed up on the selected days every week. Range N/A
enable_incremental_backup	No	Boolean	Definition Whether to enable incremental backup. Range true: The incremental backup policy is enabled. false: The incremental backup policy is disabled.

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 
   } 
 }

Example Response

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.