You are not logged in.
CreateManualBackup
This API is used to create a manual backup for a DB instance.
Name | Type | IN | Mandatory | Description |
---|---|---|---|---|
x-auth-token | string | header | Yes | Specifies the user token obtained from the IAM service. |
project_id | string | path | Yes | Specifies the project ID of a tenant in a region. |
Name | Type | Mandatory | Description |
---|---|---|---|
backup | CreateManualBackupOption object | Yes | Specifies the backup parameter object. |
Name | Type | Mandatory | Description |
---|---|---|---|
instance_id | string | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance. |
name | string | Yes | Specifies 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 | Specifies the manual backup description. The description must consist of a maximum of 256 characters and cannot contain the following special characters: >!<"&'= |
Success.
Name | Type | Description |
---|---|---|
job_id | string | The ID of the asynchronous manual backup task. |
backup_id | string | Indicates the manual backup ID. |
Client or server error.
Name | Type | Description |
---|---|---|
error_code | string | Specifies the error returned when a task submission exception occurs. |
error_msg | string | Specifies the description of the error returned when a task submission exception occurs. |
Example request
"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups"
{
"backup": {
"instance_id": "a89dab5e39394eccbdb77b19d57b0180in02",
"name": "mybackup1",
"description": "The first Manual backup"
}
}
Success.
{
"job_id": "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae",
"backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
}