API Introduction

Restore to the original
cloud server instance based on a CSBS backup by using the backup data to
override current server data. The restoration cannot be canceled once in
progress.

Preparations :

Construct a request:
Before you call an API, you must learn how to construct a request. For details,
see Construct a
Request.

Authentication: OpenAPI
requests need to be encrypted. For details, see Authentication.

API Restrictions

1. Limitations: This
API (beta) is only available to resource pools including Lhasa 3, Shanghai 7,
Guangzhou 6, Chenzhou 2, Changsha 3, Beijing 5, Inner Mongolia 6, Nanjing 3,
Chongqing 2, Hefei 2, Chengdu 4, Jinzhong, Kunming 2, Urumchi 27, Fuzhou 25, Hengyang
3, Changsha 37, Zhangjiajie 2, North 2, Beijing 1 (Central Enterprises), East
1, Shanghai 32, Shanghai 33, and Shanghai 36.

2. The backup must be
available.

3. The repository of
the backup must be available.

4. The corresponding
cloud server exists and is shut down.

5. The disk info of the
cloud server must the same as that during the backup period. Otherwise, the
data cannot be restored.

URI

<span lang="EN-US">POST /v4/ecs/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	Lower-level Object
regionID	Yes	String	Resource pool ID. You can refer toRegions and Availability Zonesto learn more about resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
instanceBackupID	Yes	String	CSBS backup ID. You can refer toProduct Definition - CSBSto learn more about CSBS. More APIs:Query a CSBS BackupandCreate a CSBS Backup.	b6e2966d-7b1c-385e-abe4-d940caa273b7

Response Parameter

Parameter	Parameter Type	Description	Example	Lower-level Object
statusCode	Integer	Return status code (800 indicates success, 900 indicates failure).	800
errorCode	String	Business code, a three-segment code in the format of product.module.code. Refer toError Codesfor more details.	Openapi.PatternCheck.NotValid
message	String	Error description upon a failure, usually in English.	SUCCESS
description	String	Error description upon a failure, usually in Chinese.	Successful
returnObj	Object	Return result.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
instanceBackupID	String	CSBS backup ID.	b6e2966d-7b1c-385e-abe4-d940caa273b7

Sample Request

Request Header

None

Request Body

Example: Restore a cloud server based on the backup when it is shut down

      "regionID": "bb9fdb42056f11eda1610242ac110002",

      "instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"

Response Parameter

    "returnObj": {

        "instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
Openapi.PatternCheck.NotValid	The request parameter is invalid.
Ecs.Parameter.InvalidNotValid	The request parameter is invalid.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
Openapi.EcsBackupWorkorder.AccessFailed	Failed to obtain the backup.
Openapi.EcsBackupWorkorder.RestoreFailed	Backup restoration failed.
Openapi.EcsBackupParameter.NotValid	The request parameter is invalid.
Ecs.State.NotStopped	The server must be shut down.
EcsBackup.BackupCheck.NotFound	The backup is not found.

Cloud Server Backup Service

Restore a CSBS Backup