Creating a Manual Backup

Description

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

URI

• URI format

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

• URI example

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/backups

Requests

• Parameter description

  Table 1 Parameter description

  Name	Type	Mandatory	Description
  backup	Object	Yes	The backup parameter objects For more information, see Table 2.

  Table 2 backup field data structure description

  Name	Type	Mandatory	Description
  instance_id	String	Yes	The instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.
  name	String	Yes	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	String	No	The manual backup description. The description must consist of a maximum of 256 characters and cannot contain the following special characters: >!<"&'=

Example Request

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

Responses

• Parameter description

  Table 3 Parameter description

  Name	Type	Mandatory	Description
  job_id	String	Yes	The ID of the asynchronous manual backup task.
  backup_id	String	Yes	Manual backup ID

• Response example

  {
      "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec",    
      "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
  }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.