Creating a Manual Backup¶
Function¶
This API is used to create a manual backup. Before using this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
POST /v3/{project_id}/backups/create
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. |
name | Yes | String | Backup name. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). |
description | No | String | Backup description. It contains a maximum of 256 characters and cannot contain the special characters |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
id | String | Backup ID. |
name | String | Backup name. |
description | String | Backup description. |
begin_time | String | Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset. |
status | String | Backup status. Value:
Valid value:
|
type | String | Backup type. Value: manual: manual full backup Valid value: manual |
instance_id | String | DB instance ID. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
Creating a Manual Backup
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
{
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07",
"name" : "backup-1",
"description": "Manual backup"
}
Example Response¶
Status code: 201
Success.
{
"backup" : {
"id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
"name" : "backup-1",
"description": "Manual backup"
"begin_time" : "2020-07-07T01:17:05+0800",
"status" : "BUILDING",
"type" : "manual",
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
},
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.