doc-exports/docs/opengauss/api-ref/opengauss_newapi_0024.html

Creating a Manual Backup

Function

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

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

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

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/backups

• Parameter description

  Table 1 Parameter description

  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

• Parameter description

  Table 2 Parameter description

  Parameter	Mandatory	Type	Description
  instance_id	Yes	String	DB instance ID.
  name	Yes	String	Backup name. It must contain 4 to 64 characters and start with a letter. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed. Minimum characters: 4 Maximum characters: 64
  description	No	String	Backup description. It contains up to 256 characters and cannot contain the following special characters: >!<"&'= Maximum characters: 256

Example Request

Creating a manual full backup for a DB instance

{
  "instance_id" : "7e01ac5ac5274957ba506f3851d11d51in14",
  "name" : "backupwqwq3",
  "description" : "manual backup"
}

Response

• Normal response

  Table 3 Response body parameters

  Parameter	Type	Description
  backup	Object	Backup information. For details, see Table 4.
  job_id	String	Task ID.

  Table 4 backup field data structure description

  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. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
  status	String	Backup status. Value: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed
  type	String	Backup type. Value: manual (manual full backup).
  instance_id	String	DB instance ID.

• Example normal response

  {
      "backup": {
          "id": "e76112bfb2074871bf54cb8df5af7f64br14",
          "name": "backupwqwq32",
          "description": "mannual backup",
          "status": "BUILDING",
          "type": "manual",
          "begin_time": "2022-05-09T18:02:31+0800",
          "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
      },
      "job_id": "e4733090-b2c8-4ea7-a33a-f55f65723fb3"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management