Updated on 2024-12-06 GMT+08:00

Stopping a Backup

Function

This API is used to stop a backup in case of an emergency.

Constraints

  • Currently, a backup can be stopped only in emergency scenarios of GeminiDB Cassandra instances.
  • This API is available only for DB instances in the Backing up or Uploading backup state.

URI

PUT https://{Endpoint}/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 ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Operation. stop indicates the operation for stopping a backup.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

ID of workflow for stopping a backup

Example Request

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/ca8cb4638f3d42bfa6e942464339be89br14 
 
{ 
  "action" : "stop" 
}

Example Response

Status code: 202

Success

{ 
  "job_id":"b52cc59d-e1e2-4e63-bb00-7694e126f66a" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.