Backing Up a DCS Instance¶

Function¶

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

Note

Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.

POST /v2/{project_id}/instances/{instance_id}/backups

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
remark	No	String	Description of DCS instance backup.
backup_format	No	String	Format of the DCS instance backup. Enumeration values: aof rdb

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
backup_id	String	Backup ID.

Status code: 400

**Table 4** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 5** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Backing up a specified DCS instance to an AOF file

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups

{
  "remark" : "Backup instances",
  "backup_format" : "aof"
}

Status code: 200

The specified DCS instance is backed up successfully.

{
  "backup_id" : "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
}

Status Code	Description
200	The specified DCS instance is backed up successfully.
400	Invalid request.
500	Internal service error.

last updated: 2024-12-11 13:46 UTC - commit: 7787fa2112623f0724071c0b63658391eb69d713