API Introduction

Query the CSBS Backup Status

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 (Center Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.
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.

<span lang="EN-US">POST /v4/ecs/backup-status</span>

Path Parameter

None

Query Parameter

None

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 callregionIDto query the latest resource pool list of eSurfing Cloud.	b6bb383e876c11ea8a5e0242ac110002
instanceBackupID	Yes	String	CSBS backup ID.	ed48dc25-d6bb-48e6-b202-3e36ee6321a3

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.
message	String	Error description upon a failure, usually in English.
description	String	Error description upon a failure, usually in Chinese.
returnObj	Object	Response Parameters		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
status	String	Backup status. Value range: CREATING, ACTIVE, RESTORING, DELETING, EXPIRED, and ERROR.

Request Body

                  "regionID": "81f7728662dd11ec810800155d307d5b",

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

    "returnObj": {

        "status": "ACTIVE"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code	Description
200	Indicate that the request succeeded

errorCode	Description
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.EcsBackupParameter.NotValid	The request parameter is invalid.
Ecs.Backup.NotFound	The backup cannot be found.

Cloud Server Backup Service