Creating a Manual Backup

Function

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

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/backups

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the 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** Parameter description
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A
name	Yes	String	Definition Backup name. Constraints N/A 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 Description of the backup file. Constraints N/A Range The value can contain up to 256 characters but cannot contain carriage return characters. The following special characters are not allowed: ! < " = ' > & Default Value N/A

Example Request

Creating a manual full backup for a DB instance

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups
{
  "instance_id" : "7e01ac5ac5274957ba506f3851d11d51in14",
  "name" : "backupwqwq3",
  "description" : "manual backup"
}

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
backup	Object	Definition Backup information. For details, see Table 4.
job_id	String	Definition Job ID. Range N/A

**Table 4** backup field data structure description
Parameter	Type	Description
id	String	Definition Backup ID. Range N/A
name	String	Definition Backup name, which must be unique. Range N/A
description	String	Definition Backup description. Range The value can contain up to 256 characters but cannot contain carriage return characters. The following special characters are not allowed: ! < " = ' > &
begin_time	String	Definition Backup start time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800. Range N/A
status	String	Definition Backup status. Range BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed
type	String	Definition Backup type. Range manual: manual full backup
instance_id	String	Definition DB instance ID. Range N/A

Example Response

{
    "backup": {
        "id": "e76112bfb2074871bf54cb8df5af7f64br14",
        "name": "backupwqwq32",
        "description": "manual backup",
        "status": "BUILDING",
        "type": "manual",
        "begin_time": "2022-05-09T18:02:31+0800",
        "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
    },
    "job_id": "e4733090-b2c8-4ea7-a33a-f55f65723fb3"
}