Creating a Manual Backup

Description

This API is used to create a manual backup for a DB instance.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/backups

Request Parameters

**Table 1** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 2** Parameter description
Parameter	Type	Mandatory	Description
backup	Object	Yes	The backup parameter objects For more information, see Table 3.

**Table 3** backup field data structure description
Parameter	Type	Mandatory	Description
instance_id	String	Yes	The instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.
name	String	Yes	The manual backup name. The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).
description	String	No	The manual backup description. The description must consist of a maximum of 256 characters and cannot contain the following special characters: >!<"&'=

Request example

{
        "backup":{
                "instance_id": "a89dab5e39394eccbdb77b19d57b0180in02",
                "name": "mybackup1",
                "description": "The first Manual backup"
        }
}

Response Parameters

Parameter description

**Table 4** Parameter description
Parameter	Type	Mandatory	Description
job_id	String	Yes	The ID of the asynchronous manual backup task.
backup_id	String	Yes	Manual backup ID

Example response

{
    "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec",    
    "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Backup and Restoration

Previous topic: Backup and Restoration

Next topic: Deleting a Manual Backup

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot