Querying Extended Backup Policies

Function

This API is used to query extended backup policies. Before calling this API:

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

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/backups/config

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
rate_limit	Integer	Definition Backup flow control. Range N/A
prefetch_block	Integer	Definition Number of differential prefetch pages. Range N/A
enable_standby_backup	Boolean	Definition Whether to enable standby node backup. Range true: This function is enabled. false: This function is disabled.
close_compression	Boolean	Definition Whether to disable backup compression. Range true: This function is disabled. false: This function is enabled.
default_backup_method	String	Definition Default backup method. Range PHYSICAL_BACKUP: physical backup EBACKUP: snapshot backup
default_backup_media_type	String	Definition Default backup storage medium. Range OBS
backup_parallel_degree	Integer	Definition Number of concurrent backup tasks. A backup task is split into multiple subtasks to improve backup efficiency. Range 1, 2, 4, or 8
backup_node_info	object	Definition Backup node information, which specifies the node or nodes within an AZ to be backed up. For details, see Table 3.

**Table 3** Data structure description of the **backup_node_info** field
Parameter	Mandatory	Type	Description
az_list	No	String	Definition Specified AZs containing nodes to be backed up. Range N/A
node_list	No	String	Definition Specified nodes to be backed up. Range N/A

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/config

Example Response

The backup flow control is 76, the number of differential prefetch pages is 65, standby node backup is enabled, backup compression is disabled, the backup method is physical backup, and the storage medium is OBS.

{ 
  "rate_limit" : 76, 
  "prefetch_block" : 65, 
  "enable_standby_backup" : true, 
  "close_compression": true,
  "backup_parallel_degree": 4 ,
  "default_backup_method": "PHYSICAL_BACKUP",
  "default_backup_media_type": "OBS", 
   "backup_node_info" : { 
     "az_list" : [], 
     "node_list" : [ "node1", "node2" ] 
   }
}