API Introduction

Query the CSBS Backup Details

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 CSBS backup must be an existing one.

URI

<span lang="EN-US">GET /v4/ecs/backup/details</span>

Path Parameter

None

Query 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 - CSBS Backupsto learn more about CSBS. More APIs:Query the CSBS Backup ListandCreate a CSBS Backup.	82ef7698-76a3-ede8-0c6d-c94a4acd73b0

Request Parameters

Request Header Parameter

None

Request Body Parameter

None

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	Response Parameters		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example
instanceBackupID	String	CSBS backup ID.	82ef7698-76a3-ede8-0c6d-c94a4acd73b0
instanceBackupName	String	CSBS backup name.	test-0012
instanceBackupStatus	String	Backup status. Value range: CREATING, ACTIVE, RESTORING, DELETING, EXPIRED, and ERROR.	ACTIVE
instanceBackupDescription	String	CSBS backup description.	test
instanceID	String	Cloud server ID.	cb51e0db-8e20-7434-4208-2a6fef86588f
instanceName	String	Cloud Server Name	test
repositoryID	String	CSBS repository ID.	c86251a9-1527-4b4e-82c7-f468ed8b8b2d
repositoryName	String	CSBS repository name.	repo-ea61
repositoryExpired	Boolean	Indicate whether the CSBS repository has expired.	false
repositoryFreeze	Boolean	Indicate whether the CSBS repository is frozen.	false
diskTotalSize	Integer	Total EVS disk capacity.	45
usedSize	Integer	Occupied disk capacity.	0
diskCount	Integer	EVS disk quantity.	2
restoreFinishedTime	String	Backup restoration completed at	null
createdTime	String	Created At	2023-03-13T05:56:33Z
finishedTime	String	Completed On	2023-03-13T06:05:51Z
projectID	String	Enterprise project ID.	0

Sample Request

Request URL

Example: Query CSBS backup details

GET .../v4/ecs/backup/details?regionID=bb9fdb42056f11eda1610242ac110002&instanceBackupID=82ef7698-76a3-ede8-0c6d-c94a4acd73b0

Request Header

None

Request Body

None

Response Example

                  "returnObj": {

                                     "finishedTime": "2023-03-13T06:05:51Z",

                                     "instanceBackupName": "test-0012",

                                     "repositoryFreeze": false,

                                     "instanceID": "cb51e0db-8e20-7434-4208-2a6fef86588f",

                                     "diskTotalSize": 45,

                                     "usedSize": 0,

                                     "diskCount": 2,

                                     "repositoryID": "c86251a9-1527-4b4e-82c7-f468ed8b8b2d",

                                     "instanceBackupID": "82ef7698-76a3-ede8-0c6d-c94a4acd73b0",

                                     "instanceBackupDescription": "test",

                                     "projectID": "0",

                                     "createdTime": "2023-03-13T05:56:33Z",

                                     "restoreFinishedTime": null,

                                     "repositoryExpired": false,

                                     "repositoryName": "repo-ea61",

                                     "instanceName": "test",

                                     "instanceBackupStatus": "ACTIVE"

},

                  "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.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
Openapi.PatternCheck.NotValid	The request parameter is invalid.
Ecs.PatternCheck.SortNotValid	The sorting parameter is invalid.
EcsBackup.Backup.NotFound	The CSBS backup is not found.
EcsBackup.WorkOrder.QueryFail	Failed to query the CSBS backup.

Cloud Server Backup Service