Help Center> GaussDB> API Reference> API> Backup Management> Creating a Manual Backup
View PDF

Creating a Manual Backup

Function

Creating a Manual Backup

URI

  • URI format

    POST https://{Endpoint}/mysql/v3/{project_id}/backups/create

  • Example

    POST https://{Endpoint}/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.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

instance_id

Yes

String

DB instance ID, which is compliant with the UUID format.

name

Yes

String

Backup name.

The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

description

No

String

Backup description. It contains a maximum of 256 characters and cannot contain the following special characters: >!<"&'=
  • Request example 
    {
   "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
   "name": "backup-1",
   "description": "manual backup"
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    backup

    Object

    Backup information.

    For details, see Table 4.
    Table 4 backup field data structure description

    Name

    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. Value:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • AVAILABLE: Backup available

    type

    String

    Backup type. Value:

    • manual: manual full backup

    instance_id

    String

    DB instance ID.
  • Example normal response 
    {
"backup": {
"id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
"name": "backup-1",
"begin_time": "2020-07-07T01:17:05+0800",
"status": "BUILDING",
"type": "manual",
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
"description": "desc"
}
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management