Backing Up a DCS Instance¶
Function¶
This API is used to back up a specified DCS instance.
Note
Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.
URI¶
POST /v1.0/{project_id}/instances/{instance_id}/backups
Table 1 describes the parameters.
Parameter | Type | Mandatory | Description |
|---|---|---|---|
project_id | String | Yes | Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID. |
instance_id | String | Yes | DCS instance ID. |
Request¶
Request parameters
Table 2 describes the request parameters.
Parameter | Type | Mandatory | Description |
|---|---|---|---|
remark | String | No | Description of DCS instance backup. |
Example request
Request URL:
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backupsExample:
{ "remark": "Backup instances" }
Response¶
Response parameters
Table 3 describes the response parameter.
Parameter | Type | Description |
|---|---|---|
backup_id | String | ID of the backup record |
Example response
{
"backup_id": "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
}
Status Code¶
Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
Status Code | Description |
|---|---|
200 | Backup task created successfully. |