Creating a Manual Backup

Updated on 2024-09-04 GMT+08:00

View PDF

Function

This API is used to create a manual backup.

Constraints

The backup name must be unique.

URI

URI format
POST /v3/{project_id}/backups

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Explanation: Instance ID. Constraints: N/A Value range: N/A Default value: N/A
name	Yes	String	Explanation: Backup name. Constraints: The backup name must be unique. Value 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	Explanation: Backup description. Constraints: N/A Value range: It contains a maximum of 256 characters and cannot contain the special characters >!<"&'=. Default value: N/A

Example Request

Create a manual backup named mybackup for a FlexusRDS instance.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups
{
	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
	"name": "mybackup",
	"description": "manual backup"
}

Response

Normal response

**Table 3** Parameters
Parameter	Type	Description
backup	Object	Explanation: Backup information. For details, see Table 4.

**Table 4** backup field data structure description
Parameter	Type	Description
id	String	Explanation: Backup ID. Value range: N/A
instance_id	String	Explanation: Instance ID. Value range: N/A
name	String	Explanation: Backup name. Value range: It must be 4 to 64 characters long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).
description	String	Explanation: Backup description. Value range: It contains a maximum of 256 characters and cannot contain the special characters >!<"&'=.
begin_time	String	Explanation: 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. Value range: N/A
status	String	Explanation: Backup status. Value range: BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed DELETING: backup being deleted
type	String	Explanation: Backup type. Value range: auto: automated full backup manual: manual full backup fragment: differential full backup incremental: automated incremental backup

Example normal response

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