Updated on 2025-10-21 GMT+08:00

Creating a Manual Backup

Function

This API is used to create a manual backup.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Constraints

Read replicas do not support manual backup creation.
The backup name must be unique.

URI

URI format
POST /v3/{project_id}/backups

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
name	Yes	String	Definition Backup name. Constraints The backup name must be unique. Range It must be 4 to 64 characters long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_). Default Value N/A
description	No	String	Definition Backup description. Constraints N/A Range It can contain a maximum of 256 characters and cannot contain the following special characters: >!<"&'= Default Value N/A
databases	No	Array of objects	Definition List of user-created databases for partial backup. For details, see Table 3. Constraints This parameter is only available for RDS for PostgreSQL and RDS for SQL Server. If backup_database_individually is set to true, databases is mandatory.

**Table 3** databases field data structure description
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Names of user-created databases. Constraints N/A Range N/A Default Value N/A

Example Request

Create a manual backup mybackup for an RDS for MySQL DB instance.

{
	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
	"name": "mybackup",
	"description": "manual backup"
}

Create a manual backup mybackup for an RDS for PostgreSQL DB instance.

{
	"instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03",
	"name": "mybackup",
	"description": "manual backup"
}

Create a manual backup mybackup for an RDS for SQL Server DB instance.

{
	"instance_id": "34029da944074135a3bc24c75b3bb3edin04",
	"name": "mybackup",
	"description": "manual backup",
	"databases": [{
		"name": "db1"
	}, {
		"name": "db2"
	}]
}

Response

Normal response

**Table 4** Parameters
Parameter	Type	Description
backup	Object	Definition Indicates the backup information. For details, see Table 5.

**Table 5** backup field data structure description
Parameter	Type	Description
id	String	Definition Indicates the backup ID. Range N/A
instance_id	String	Definition Indicates the DB instance ID. Range N/A
name	String	Definition Indicates the backup name. Range N/A
description	String	Definition Indicates the backup description. Range N/A
databases	Array of objects	Definition Indicates a list of user-created databases for partial backup. This parameter is only available for RDS for PostgreSQL and RDS for SQL Server. For details, see Table 6.
begin_time	String	Definition Indicates the backup start time. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start of the time field, and "Z" indicates the time zone offset.
status	String	Definition Indicates the backup status. Range BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed DELETING: backup being deleted
type	String	Definition Indicates the backup type. Range auto: automated full backup manual: manual full backup fragment: differential full backup incremental: automated incremental backup

**Table 6** databases field data structure description
Parameter	Type	Description
name	String	Definition Names of user-created databases. Range N/A

Example normal response

Creating a manual backup for an RDS for MySQL DB instance:

{
	"backup": {
		"id": "cb211c0075104151a748a854bc8bd87dbr01",
		"name": "mybackup",
		"description": "manual backup",
		"begin_time": "2022-08-23T07:41:50Z",
		"status": "BUILDING",
		"type": "manual",
		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
	}
}

Creating a manual backup for an RDS for PostgreSQL DB instance:

{
	"backup": {
		"id": "104b59afd83d4fc7b2c03ad14c4be080br03",
		"name": "mybackup",
		"description": "manual backup",
		"begin_time": "2022-08-23T07:20:36Z",
		"status": "BUILDING",
		"type": "manual",
		"instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03"
	}
}

Creating a manual backup for an RDS for SQL Server DB instance:

{
	"backup": {
		"id": "6f7b5904b04043b38ad764e33daba810br04",
		"name": "mybackup",
		"description": "manual backup",
		"begin_time": "2022-08-23T07:15:28Z",
		"status": "BUILDING",
		"type": "manual",
		"instance_id": "34029da944074135a3bc24c75b3bb3edin04",
		"databases": [{
			"name": "db1"
                }, {
			"name": "db2"
		}]
	}
}

Abnormal response
For details, see Abnormal Request Results.

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Backup and Restoration