Creating a Manual Backup

Function

This API is used to create a manual backup for a DB instance.

URI

• URI format

  POST /v3/{project_id}/backups

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.

Requests

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  backup	Yes	Object	Specifies the backup parameter objects For more information, see Table 3.

  Table 3 backup field data structure description

  Name	Mandatory	Type	Description
  instance_id	Yes	String	Specifies the DB instance ID.
  name	Yes	String	Specifies the manual backup name. The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).
  description	No	String	Specifies the manual backup description. The description must consist of a maximum of 256 characters and cannot contain the following special characters: >!<"&'=

• Request header

  POST https://DDS endpoint/v3/{project_id}/backups

• Example request

  {
          "backup":{
                  "instance_id": "a89dab5e39394eccbdb77b19d57b0180in02",
                  "name": "mybackup1",
                  "description": "The first Manual backup"
          }
  }

Responses

• Parameter description

  Table 4 Parameter description

  Name	Type	Description
  backup_id	String	Indicates the manual backup ID.

• Response example

  {
      "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
  }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.