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¶

URI format
POST https://{endpoint}/mysql/v3/{project_id}/backups/create
Example
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
Parameter description
Table 1 Parameter description¶
Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
To obtain this value, see Obtaining a Project ID.

**Table 1** Parameter description¶
Name	Mandatory	Description
project_id	Yes	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	No	String	User token.
X-Language	No	String	Language.
Content-Type	Yes	String	MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
instance_id	Yes	String	DB instance ID, which is compliant with the UUID format.
name	Yes	String	Backup name. The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).
description	No	String	Backup description. It contains a maximum of 256 characters and cannot contain the special characters `(>!<"&'=)`

Response Parameters¶

Status code: 200

**Table 4** Response body parameter¶
Parameter	Type	Description
backup	backup object	Backup information.

**Table 5** backup¶
Parameter	Type	Description
id	String	Backup ID.
name	String	Backup name.
descriprion	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 Valid value: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed AVAILABLE: Backup available
type	String	Backup type. Value: Valid value: manual: manual full backup
instance_id	String	DB instance ID.

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://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
{
   "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
   "name": "backup-1",
   "description": "manual backup"
}

Example Response¶

Status code: 200

Success.

{
  "backup" : {
    "id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
    "name" : "backup-1",
    "description": "Manual backup"
    "begin_time" : "2020-07-07T01:17:05+0200",
    "status" : "BUILDING",
    "type" : "manual",
    "instance_id" : "ef25188419f941309882d2986b2210b9in07"
  }
}

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-11-13 14:30 UTC - commit: 805f4aa7e58669fc866d3eb0c4241508900e849d