Querying an Automated Backup Policy_Backups and Restorations_APIs v3_API Reference

Function

This API is used to query an automated backup policy, including GeminiDB Cassandra databases and tables.

Constraints

This API supports the following instance types:

GeminiDB Cassandra
GeminiDB Influx
GeminiDB Redis

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

Response Parameters

Status code: 202

**Table 3** Response body parameter
Parameter	Type	Description
backup_policy	object	Backup policy objects, including the backup retention period (days) and start time. For details, see Table 4.

**Table 4** ShowBackupPolicyResult
Parameter	Type	Description
keep_days	Integer	Backup retention days
start_time	String	Backup time window. Automated backup will be triggered during the backup time window.
period	String	Backup period. After a backup period is specified, data will be automatically backed up on the selected days every week.

Example Request

URI example

GET https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy

Example Response

Status code: 202

Success

Enabling an automated backup policy

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

Disabling an automated backup policy

{
  "backup_policy" : {
    "keep_days" : 0
  }
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Querying an Automated Backup Policy