Restoring a DCS Instance¶

Function¶

This API is used to restore a specified DCS instance.

Note

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

POST /v1.0/{project_id}/instances/{instance_id}/restores

Table 1 describes the parameters.

**Table 1** Parameter description¶
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 parameters

Table 2 describes the request parameters.

**Table 2** Parameter description¶
Parameter	Type	Mandatory	Description
remark	String	No	Description of DCS instance restoration
backup_id	String	Yes	ID of the backup record

Example request

Request URL:

POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores

Example:

{
    "remark":"restore instance",
    "backup_id":"8ba256cb-e5ac-44f6-a3da-c03d8f0e5029"
}

Response parameters

Table 3 describes the response parameter.

**Table 3** Parameter description¶
Parameter	Type	Description
restore_id	String	ID of the restoration record

Example response

{
    "restore_id": "a6155972-800c-4170-a479-3231e907d2f6"
}

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	Restoration task created successfully.

last updated: 2024-05-19 03:17