Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Querying an Automated Backup Policy
Updated on 2024-10-30 GMT+08:00
View PDF
Share

Querying an Automated Backup Policy

Function

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

Constraints

This API supports the following types of instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

URI

GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy

Table 1 Path 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.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

No

String

Backup policy type. This parameter is available only to GeminiDB Cassandra. The value can be:

  • Instance: An instance backup is queried.
  • DatabaseTable: A database or table backup is queried.
  • The default value is Instance.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backup_policy

object

Backup policy objects, including the backup retention period (days) and start time. For details, see Table 5.
Table 5 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 Requests

URI example 
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/764b8a2763d34414ad3f2d5495416cb5in06/backups/policy?type=DatabaseTable

Example Responses

Status code: 200

Success

Enabling automated backup

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

Disabling automated backup

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations