API Introduction

Query the VBS backup list.

API Restrictions

None

URI

<span lang="EN-US">GET /v4/ebs-backup/list-backups</span>

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
diskID	No	String	EVS ID	0c582801-6b20-4e3a-956a-f3afbb5e9725
diskName	No	String	EVS Name	test-vol
backupName	No	String	VBS Backup name.	test-bak
repositoryID	No	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
backupStatus	No	String	VBS Backup status. Valid values: available, error, and creating.	available
queryContent	No	String	This parameter can be used for fuzzy filtering of disk IDs, disk names, backup IDs, and backup names. This means that fields with the value of this parameter will be the filtered results.	bak
pageNo	No	Integer	Page number. Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Default value: 10.	10
projectID	No	String	Enterprise project ID. Default value: 0.	0

Request Parameters

Request Header Parameter

None

Request Body Parameter

None

Response Parameter

Parameter	Required or Not	Type	Description	Example	Lower-level Object
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	Object returned upon a success.		returnObj
errorCode	No	String	Business code, returned upon failures.	Refer to error codes

Table returnObj

Parameter Name	Required or Not	Parameter Type	Description	Example	Lower-level Object
backupList	Yes	Array	VBS backup list.		backupList
totalCount	Yes	Integer	Total number of VBS backups.	11
currentCount	Yes	Integer	Number of VBS backups on the current page.	10

Table backupList

Parameter Name	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
backupName	Yes	String	VBS Backup name.	test-bak
backupStatus	Yes	String	VBS backup status. Valid values: available, error, restoring, creating, and deleting.	available
diskSize	Yes	Integer	EVS disk capacity (GB).	100
backupSize	Yes	Integer	VBS backup size (byte).	1024000
description	Yes	String	VBS backup description.	test-bak's description
repositoryID	Yes	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	Yes	String	Repository name.	test-repo
createdTime	Yes	Integer	Created At	1663136607
updatedTime	Yes	Integer	Update At	1663136607
finishedTime	Yes	Integer	Backup completion time.	1663136607
restoredTime	Yes	Integer	Restoration starting time.	1663136607
restoreFinishedTime	Yes	Integer	Restoration completion time.	1663136607
freeze	Yes	Boolean	Indicate whether the repository is frozen.	false
diskID	Yes	String	EVS ID	0c582801-6b20-4e3a-956a-f3afbb5e9725
diskName	Yes	String	EVS Name	test-vol
encrypted	Yes	Boolean	Indicate whether the EVS disk is encrypted.	false
diskType	Yes	String	EVS disk type. Value range: SATA: ordinary I/O. SAS: high I/O. SSD: ultra-high I/O. SSD-genric: general-purpose SSD. FAST-SSD: express SSD.	SATA
paas	Yes	Boolean	Indicate whether PAAS is supported.	false
instanceID	Yes	String	ID of the mounted cloud server.	f2338f53-81b1-4fef-72cc-9f72b5fe705c
instanceName	Yes	String	Name of the mounted cloud server.	test-vm
projectID	Yes	String	Enterprise project ID.	0

Sample Request

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "totalCount": 3,

        "currentCount": 1,

        "backupList": [{

            "diskName": "vm1-az2-3157-volume",

            "backupSize": 837772499,

            "repositoryID": "2e2f1de4-1ff8-4898-8bac-58fc39078b87",

            "instanceName": "",

            "diskSize": 40,

            "regionID": "81f7728662dd11ec810800155d307d5b",

            "encrypted": false,

            "repositoryName": "test-bak-repo",

            "restoredTime": null,

            "status": "available",

            "description": "",

            "instanceID": "",

            "createdTime": 1675972802,

            "freeze": false,

            "paas": false,

            "backupName": "autobk-fqi1-0001",

            "restoreFinishedTime": null,

            "diskType": "SATA",

            "diskID": "d75fdd79-5b67-442e-b8c6-35c6de7f35ab",

            "updatedTime": 1675973456,

            "finishedTime": 1675973456,

            "backupID": "da0f4df9-f567-4a37-94a6-bf8d3e3ef83d",

            "projectID": "0"

        }]},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

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.AccessFailed	Failed to query the backup.
EbsBackup.BackupInfo.DataDamaged	The VBS backup data is incorrect.
EbsBackup.Parameter.InvalidPageParams	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.
EbsBackup.OrderCheck.InvalidProjectID	The enterprise project does not exist. Please check whether the project ID is valid.

Volume Backup Service

Query the Backup List