Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Creating a Manual Backup
Updated on 2025-07-11 GMT+08:00
View PDF

Creating a Manual Backup

Function

This API is used to create a manual backup. Before calling this API:

URI

POST /v3/{project_id}/backups/create

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:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 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.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Definition:

Instance ID, which uniquely identifies an instance.

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

name

Yes

String

Definition:

Backup name.

Range:

description

No

String

Definition:

Backup description.

Range:

The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: !<"='>&

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

backup

backup object

Definition:

Backup information.

job_id

String

Definition:

Job ID.

Range:

N/A
Table 5 backup

Parameter

Type

Description

id

String

Definition:

Backup ID.

Range:

N/A

name

String

Definition:

Backup name.

Range:

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

description

String

Definition:

Backup description.

Range:

The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: !<"='>&

begin_time

String

Definition:

Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.

Range:

N/A

status

String

Definition:

Backup status.

Range:

  • BUILDING: backup in progress

  • COMPLETED: backup completed

  • FAILED: backup failed

  • AVAILABLE: backup available

type

String

Definition:

Backup type.

Range:

manual: manual full backup

instance_id

String

Definition:

Instance ID.

Range:

The value is the same as the instance ID in the request.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Creating a manual backup

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
{
  "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07",
  "name" : "backup-1",
  "description": "Manual backup"
}

Example Response

Status code: 201

Success.

{
  "backup" : {
    "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
    "name" : "backup-1",
    "description": "Manual backup"
    "begin_time" : "2020-07-07T01:17:05+0800",
    "status" : "BUILDING",
    "type" : "manual",
    "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
  },
  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management