Updated on 2026-09-22 GMT+08:00

Stopping a Backup

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

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.

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

gaussdbfornosql:instance:stopBackup

write

-

-

nosql:backup:stop

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:stopBackup	write	-	-	nosql:backup:stop	-

PUT /v3/{project_id}/backups/{backup_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
backup_id	Yes	String	Definition Backup file ID For details about how to obtain the value, see backups in "Response Parameters" in Querying Backups. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Type of the operation performed on the backup. Constraints N/A Range stop: The backup is stopped. Default Value N/A

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

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

Status code: 202

Success

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

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Backups and Restorations