Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Creating a Manual Backup
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Creating a Manual Backup

Function

This API is used to create a manual backup.

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:createBackup

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:backup:create

    -

URI

POST /v3/{project_id}/instances/{instance_id}/backups

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Manual backup name.

Constraints

The value can contain 4 to 64 characters and must start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

Range

N/A

Default Value

N/A

description

Yes

String

Definition

Manual backup description.

Constraints

The value can include a maximum of 256 characters and cannot contain special characters >!<"&'=

Range

N/A

Default Value

N/A

database_tables

No

Array of objects

Definition

Database and table information in the backup. For details, see Table 4.

Constraints

This parameter is available only to GeminiDB Cassandra API.

Range

  • If this parameter is left blank, an instance backup is created.
  • If this parameter is left blank, a database backup or table backup is created.

Default Value

N/A
Table 4 DatabaseTableInfo

Parameter

Mandatory

Type

Description

database_name

Yes

String

Definition

Database name.

Constraints

N/A

Range

N/A

Default Value

N/A

table_names

No

Array of strings

Definition

Table names

Constraints

N/A

Range

  • If this parameter is empty, backups are created for databases.
  • If this parameter is not empty, backups are created for tables.

Default Value

N/A

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

backup_id

String

Definition

Backup ID.

Range

N/A

Example Requests

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups
  • Creating a manual database- and table-level backup 
    {
   "name": "Creating a manual database- and table-level backup",
   "description": "Create a manual database- and table-level manual backup.",
   "database_tables" : [ { 
     "database_name" : "databaseNameA", 
     "table_names" : [ "table_A", "table_B" ] 
   }, { 
     "database_name" : "databaseNameB", 
     "table_names" : null 
   } ] 
 }

Example Responses

Status code: 202

Successful response

{ 
  "job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05", 
  "backup_id" : "646d88d0b03f4fd2ae944ae2a33bcb6ain06" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations