Creating a Manual Backup

Function

This API is used to create a manual backup.

Constraints

The backup name must be unique.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

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
rds:backup:create	write	-	-	-	-

URI

URI format
POST /v3/{project_id}/backups

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 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 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 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	Definition Backup information. For details, see Table 4.

**Table 4** backup field data structure description
Parameter	Type	Description
id	String	Definition Backup ID. Range N/A
instance_id	String	Definition Instance ID. Range N/A
name	String	Definition Backup name. 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	Definition Backup description. Range It contains a maximum of 256 characters and cannot contain the 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 DELETING: backup being deleted
type	String	Definition Backup type. 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"
	}
}