Help Center/ GeminiDB/ API Reference/ APIs v3.1 (Recommended)/ Backup and Restoration/ Querying an Automated Backup Policy
Updated on 2025-12-04 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 instances:

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

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    gaussdbfornosql:instance:getBackupPolicy

    Read

    instance *

    -

    nosql:backup:list

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID To obtain the value, call the API by following Querying Instances and Details. If you do not have an instance, call the API by following Creating an Instance.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

No

String

Definition

Backup policy type This parameter is available only to GeminiDB Cassandra API.

Constraints

N/A

Range

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

Default Value

Instance

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

To obtain this value, call the IAM API for obtaining a user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backup_policy

object

Definition

Backup policy objects, including the backup retention period (days) and start time. For details, see Table 5.

Range

N/A
Table 5 ShowBackupPolicyResult

Parameter

Type

Description

keep_days

Integer

Definition

Backup retention days

Range

N/A

start_time

String

Definition

Backup time window. Automated backups will be created during the backup time window.

Range

N/A

period

String

Definition

Backup cycle. Automated backups will be created on the specified days every week.

Range

N/A

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

Successful response

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: Backup and Restoration