Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Backup and Restoration/ Stopping a Backup
Updated on 2024-08-20 GMT+08:00
View PDF
Share

Stopping a Backup

Function

This API is used to stop backups of a DB instance, including all its ongoing full and differential backups. Before calling this API:

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/stop

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Table 2 Response body parameters

Name

Type

Description

job_id

String

Task ID.

Example Request

Stopping a backup

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/stop

Example Response

Backup stopped.

{ 
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration