API Introduction

Restore a VBS backup.

This applies to the old version of API operations and may not be applicable in the future. We recommend you use the new version, which is more standard and covers more scenarios.

API Restrictions

None

URI

<span lang="EN-US">POST /v4/ebs-backup/restore</span>

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
backupID	Yes	String	VBS backup ID.	59093d15-8a3c-53b9-b61b-484af10a3e97
volumeID	Yes	String	EVS ID	0c582801-6b20-4e3a-956a-f3afbb5e9725

Response Parameter

Parameter	Required or Not	Type	Description	Example
statusCode	Yes	Integer	Return status code (800 indicates success, 900 indicates failure).	800
message	Yes	String	Error descripting in English.	SUCCESS
description	Yes	String	Error description in Chinese.	Successful
returnObj	No	Object	Data returned upon success. Value: {}.
errorCode	No	String	Business code, returned upon failures.	Refer to error codes

Sample Request

Request Body

    "regionID": "81f7728662dd11ec810800155d307d5b",

    "backupID": "59093d15-8a3c-53b9-b61b-484af10a3e97",

    "volumeID": "0c582801-6b20-4e3a-956a-f3afbb5e9725"

Response Example

    "statusCode": 800,

    "message": "SUCCESS",

    "description": "Successful",

    "returnObj": {}

Error Codes

errorCode	Description
EbsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EbsBackup.RegionInfo.AccessFailed	Failed to query the resource pool. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.RegionInfo.DataDamaged	The resource pool information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.BackupInfo.NotFound	The VBS backup is not found.
EbsBackup.BackupInfo.InvalidState	The EVS disk status does support this operation.
EbsBackup.DiskInfo.NotFound	The EVS disk is not found.
EbsBackup.DiskInfo.Empty	The disk info is empty.
EbsBackup.DiskInfo.InvalidState	The current EVS disk state.VBS does support this operation.
EbsBackup.VmInfo.NotStopped	The cloud server is not shut down.
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.

Volume Backup Service

Restore a Backup