Help Center> Distributed Cache Service> API Reference> Backup and Restoration APIs> Backing Up a DCS Instance
View PDF

Backing Up a DCS Instance

Function

This API is used to back up a specified DCS instance.

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.
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

instance_id

String

Yes

DCS instance ID.

Request

Request parameters

Table 2 describes the request parameters.
Table 2 Parameter description

Parameter

Type

Mandatory

Description

remark

String

No

Description of DCS instance backup.

Example request

POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
{
    "remark": "Backup instances"
}

Response

Response parameters

Table 3 describes the response parameter.
Table 3 Parameter description

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.

Table 4 Status code

Status Code

Description

200

Specified DCS instance backed up successfully.