Backing Up and Restoring a Microservice Engine

Function

This API is used to restore a specified microservice engine using a specified backup file.

URI

POST /cseengine/v1/engines/{engine_id}/backups/{backup_id}/recovery

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
engine_id	Yes	String	Microservice engine ID.
backup_id	Yes	String	Backup file ID.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Enterprise-Project-ID	No	String	If this parameter is not set, the default enterprise project is default and the ID is 0.
Content-Type	Yes	String	Set it to application/json;charset=UTF-8.
Accept	Yes	String	Set it to application/json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a restoration record.
description	No	String	Description of a restoration record.

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	ID of the restoration record.
engineId	String	Microservice engine ID.
backupId	String	ID of the microservice engine backup file.
status	String	Status of the microservice engine restoration record. Range: RecoveringData RestartingService RecoveringDataFailed RestartingServiceFailed Success
backupName	String	Name of the microservice engine backup file.
name	String	Name of the microservice engine restoration record.
description	String	Description of the microservice engine restoration record.
progress	Integer	Data restoration progress.
time	Long	Data restoration duration.
reason	String	Reason why data fails to be restored.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Request

POST https://{endpoint}/cseengine/v1/engines/{engine_id}/backups/{backup_id}/recovery

{
  "name" : "string",
  "description" : "string"
}

Example Response

Status code: 200

Response structure for backing up and restoring a microservice engine.

{
  "id" : "string",
  "name" : "test",
  "description" : "string",
  "engineId": "engineId",
  "backupId": "backupId",
  "backupName": "backupName",
  "status": "RecoveringData",
  "progress": "20",
  "time": "123",
  "reason": "string"
}