Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Backups and Restorations> Creating a Manual Backup
Updated on 2023-11-21 GMT+08:00
View PDF

Creating a Manual Backup

Function

This API is used to create a manual backup.

Constraints

This API supports the following types of instances:

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

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Manual backup name.

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

description

Yes

String

Manual backup description.

The description can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'=

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

backup_id

String

Backup ID.

Example Requests

  • URI example
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups
  • Creating a manual backup
    {
"name": " Create a manual backup",
"description": " Creating a manual backup",
 }

Example Responses

Status code: 200

Success

{ 
  "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