Stopping a Backup

Description

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

Restrictions

This API is available only for DB instances in the Backing up or Uploading backup state.

URI

URI format
PUT https://{Endpoint}/v3/{project_id}/backups/{backup_id}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/backups/ca8cb4638f3d42bfa6e942464339be89br14

**Table 1** Request parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.
backup_id	string	path	Yes	Backup ID.

Requests

Parameter description

**Table 2** Parameter description
Parameter	Type	Mandatory	Description
action	String	Yes	Operation. stop indicates the operation for stopping a backup.

Example request
```
{ 
  "action" : "stop" 
}
```

Responses

Parameter description

**Table 3** Parameter description
Parameter	Type	Description
job_id	String	ID of the workflow for stopping a backup.

Example response

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

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.