API Introduction

Query the CSBS Backup List

API Restrictions

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.

URI

<span lang="EN-US">POST /v4/ecs/backup-list</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. You can callregionIDto query the latest resource pool list of eSurfing Cloud.	b6bb383e876c11ea8a5e0242ac110002
pageNo	No	Integer	Page number. Value range: greater than or equal to 1. Default value: 1.	1
pageSize	No	Integer	Data entries on each page. Value range: [1~50]. Default value: 10. Maximum entries on one page: 50.	10
ID	No	String	Cloud server ID.	de70ef00-1ea0-459a-b74d-b06272561a32
repositoryID	No	String	Repository ID.	de70ef00-1ea0-459a-b74d-b06272561a32
instanceBackupID	No	String	CSBS backup ID.	ed48dc25-d6bb-48e6-b202-3e36ee6321a3
queryContent	No	String	Content for fuzzy match, by ID or name.	backup-test01
status	No	String	CSBS backup status.	ACTIVE
projectID	No	String	Enterprise project ID.	0

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.
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
currentCount	Integer	Number of records on current page.	1
totalCount	Integer	Total number of records.	10
totalPage	Integer	Total number of pages.	1
results	Array of Objects	Pagination details.		results

Table results

Parameter	Parameter Type	Description	Example	Lower-level Object
volumeCount	Integer	EVS disk quantity.	3
restoreFinishTime	String	Restoration time.	2023-07-24T04:00:10Z
instanceBackupID	String	CSBS backup ID.	ed48dc25-d6bb-48e6-b202-3e36ee6321a3
repoFreezing	Boolean	Indicate whether the repository is frozen. Value range: true and false.	false
size	Integer	Backup size.	60
repositoryID	String	Repository ID.	986035b0-7862-4a1c-b020-3c2cef81dd6d
repositoryName	String	Repository name.	repo-test01
deleted	Boolean	Indicate whether the resource is deleted.	false
usedSize	Integer	Used size.	755379636
status	String	Backup status. Value range: CREATING, ACTIVE, RESTORING, DELETING, EXPIRED, and ERROR.	ACTIVE
description	String	Backup Description	backup_desc_test
instanceID	String	Cloud server ID.	de70ef00-1ea0-459a-b74d-b06272561a32
instanceName	String	Cloud Server Name	ecm-9014
repoExpired	Boolean	Indicate whether the repository is expired.	false
instanceBackupName	String	CSBS backup name.	backup-test01
block_device_mappings	Array of Objects	Mapping list of EVS disks of the cloud server.		blockDeviceMappingS
createAt	String	Created At	2023-07-24T04:00:10Z
updateAt	String	Update At	2023-07-24T04:00:10Z
finishTime	Integer	Completed On	023-07-24T04:10:02Z
projectID	String	Enterprise project ID.	0

Table blockDeviceMappingS

Parameter	Parameter Type	Description	Example
backup_id	String	VBS backup ID.	d270c7e2-275f-43b7-a5a3-7bc52c892972
volume_id	String	EVS ID	d270c7e2-275f-43b7-a5a3-7bc52c892972
boot_volume	Boolean	Indicate whether this is a startup disk.	true
mount_device	String	Device mounted to the EVS disk.	/dev/vda
volume_size	String	EVS disk capacity.	40
volume_type	String	EVS disk type. Value range: SATA: general IO. SAS: high IO. SSD: ultra-high IO. SSD-genric: general-purpose SSD. FAST-SSD: express SSD.	SAS-public
delete_on_termination	Boolean	Indicate whether the resource is deleted together with the mounted cloud server.	true
boot_index	Integer	Boot order.	0
device_name	String	Name of the mounted device.	/dev/vda
container	String	container	a7135589f022439c1edefc74b9336f7a
service_metadata	String	Service metadata.	a8b318a7-c07f-6eb4-8fb9-72a897cc9f65/volume_25e2248b-a5ca-4e27-b1be-76155ef16dbd/20221031025806/az_nova_backup_0634f102-b14c-42fa-bc35-38f669a9c52a

Sample Request

Request Body

                       "regionID": "81f7728662dd11ec810800155d307d5b",

    "pageNo":1,

    "pageSize":50,

    "repositoryID": "62a7cd2f-55a4-4a65-bb64-6f8352b4f55f",

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

    "queryContent": ""

Response Example

    "returnObj": {

        "currentCount": 1,

        "totalCount": 1,

        "totalPage": 1,

        "results": [

                "status": "ACTIVE",

                "instanceBackupName": "openapi-test-0001-0016",

                "volumeCount": 1,

                "repoFreezing": false,

                "usedSize": 835228300,

                "block_device_mappings": [

                        "backup_id": "0634f102-b14c-42fa-bc35-38f669a9c52a",

                        "mount_device": "/dev/vda",

                        "is_bootable": true,

                        "volume_type": "SATA-public",

                        "device_name": "vda",

                        "volume_size": 40,

                        "boot_index": 1,

                        "boot_volume": true,

                        "volume_id": "25e2248b-a5ca-4e27-b1be-76155ef16dbd",

                        "container": "a7135589f022439c1edefc74b9336f7a",

                        "service_metadata": "a8b318a7-c07f-6eb4-8fb9-72a897cc9f65/volume_25e2248b-a5ca-4e27-b1be-76155ef16dbd/20221031025806/az_nova_backup_0634f102-b14c-42fa-bc35-38f669a9c52a",

                        "delete_on_termination": true

],

                "repositoryID": "0da07640-6e76-4642-8a65-xxxxxxxxxxx",

                "updateAt": "2022-10-31T03:09:03Z",

                "size": 40,

                "finishTime": "2022-10-31T03:09:03Z",

                "instanceID": "9e32a0de-f7a5-058a-85f1-xxxxxxxxxxxxx",

                "description": "openapi-test",

                "deleted": false,

                "createAt": "2022-10-31T02:58:04Z",

                "repoExpired": false,

                "projectID": "0",

                "instanceBackupID": "a8b318a7-c07f-6eb4-8fb9-xxxxxxxxxxxx",

                "repositoryName": "repo-97e8"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

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

Query the CSBS Backup List