Help Center> GaussDB(for MySQL)> API Reference> APIs (Recommended)> Backup Management> Deleting a Manual Backup
Updated on 2023-12-20 GMT+08:00
View PDF

Deleting a Manual Backup

Function

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

URI

DELETE /v3/{project_id}/backups/{backup_id}

Table 1 URI parameters

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.

backup_id

Yes

String

Backup file ID.

To obtain this value, see Querying Full Backups.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

backup_id

String

Backup ID.

backup_name

String

Backup name.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting a manual backup

DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/1fe4feaab48f11e6654hfa163eba87e4b66

Example Response

Status code: 200

Success.

{
  "backup_id" : "b1182ccdda034f2b9535f3dca5c47e71br07",
  "backup_name" : "backup-f3c1"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management