Creating a Manual Backup
Function
This API is used to create a manual backup.
Constraints
This API supports the following types of instances:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
URI
POST /v3/{project_id}/instances/{instance_id}/backups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
instance_id |
Yes |
String |
Explanation: Instance ID. Constraints: N/A Values: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Explanation: Manual backup name. Values: Can include 4 to 64 characters and must start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). |
description |
Yes |
String |
Explanation: Manual backup description. Values: Can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'= |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Explanation: Task ID. Values: N/A |
backup_id |
String |
Explanation: Backup ID. Values: N/A |
Example Request
- URI example
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups
- Creating a manual backup
{ "name": " Create a manual backup", "description": " Creating a manual backup", }
Example Response
Status code: 202
Success
{ "job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05", "backup_id" : "646d88d0b03f4fd2ae944ae2a33bcb6ain06" }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot