Creating a Manual Backup

Function

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/backups/create

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.
name	Yes	String	Backup name. 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	No	String	Backup description. It contains up to 256 characters and cannot contain the following special characters: >!<"&'=

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
backup	backup object	Backup information.
job_id	String	Task ID.

**Table 5** backup
Parameter	Type	Description
id	String	Backup ID.
name	String	Backup name.
description	String	Backup description.
begin_time	String	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.
status	String	Backup status. Values: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed AVAILABLE: Backup available Enumerated values: BUILDING COMPLETED FAILED AVAILABLE
type	String	Backup type. Value: manual (manual full backup) Enumerated values: manual
instance_id	String	Instance ID, which is compliant with the UUID format.

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"
}