API Introduction

Query the VBS repository list.

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.

API Restrictions

None

URI

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

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
repositoryName	No	String	VBS Repository name.	test-repo
repositoryID	No	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
status	No	String	Repository status. Value range: active, creating, error, freezing, and expired.	active
hideExpire	No	Boolean	Specify whether to hide expired repositories.	true
queryContent	No	String	Currently, you can only filter the query results by the repository name.	repo
pageNo	No	Integer	Page number. Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Default value: 10.	10
asc	No	Boolean	Used with the sort parameter to specify whether to sort data in an ascending order.	true
sort	No	String	Used with the asc parameter to specify the field used for sorting. Value range: createdDate, expiredDate, size, freeSize, usedSize, and name.	createdDate
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
repositoryList	Yes	Array	VBS Repository list.		repositoryList
totalCount	Yes	Integer	Total number of VBS repositories.	11
currentCount	Yes	Integer	Number of repositories on the current page.	10

Table repositoryList

Parameter Name	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
repositoryID	Yes	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	Yes	String	Repository name.	test-repo
status	Yes	String	Repository status. Value range: active, creating, error, freezing, and expired.	active
size	Yes	Integer	Total repository capacity (GB).	100
freeSize	Yes	Integer	Remaining repository capacity (GB).	90
usedSize	Yes	Integer	Occupied capacity of the repository (byte).	10240000000
createdDate	Yes	Integer	Created At	663136607
updatedDate	Yes	Integer	Update At	663136607
expiredDate	Yes	Integer	Expiration Time	663136607
expired	Yes	Boolean	Indicate whether the repository has expired.	false
freeze	Yes	Boolean	Indicate whether the repository is frozen.	false
customerID	Yes	String	User ID	59093d15-8a3c-53b9-b61b-484af10a3e97
azName	Yes	String	Available zone name.	null
paas	Yes	Boolean	Indicate whether PAAS is supported.	false
backupList	Yes	array	List of available backups in the repository. The elements are backup IDs.	["59093d15-8a3c-53b9-b61b-484af10a3e97","59093d15-8a3c-53b9-b61b-484af10a3e98"]
paymentType	Yes	String	Payment Methods	null
projectID	Yes	String	Enterprise project ID.	0

Sample Request

Request Header

None

Request Body

None

Response Example

    "returnObj":

        "totalCount": 6,

        "currentCount": 1,

        "repositoryList": [{

            "status": "active",

            "paas": false,

            "expiredDate": 1678927767,

            "paymentType": null,

            "regionID": "81f7728662dd11ec810800155d307d5b",

            "usedSize": 0,

            "repositoryID": "9badc8dd-8dff-4acb-8bf4-4c0f99e89118",

            "freeze": false,

            "updatedDate": 1676508582,

            "azName": null,

            "createdDate": 1676508551,

            "backupList": [],

            "customerID": "84e0ef66-b86d-5927-b144-95f47f63a91f",

            "repositoryName": "yue20230216test04",

            "expired": false,

            "freeSize": 120,

            "size": 120,

            "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.RepositoryInfo.AccessFailed	Failed to query the VBS repository.
EbsBackup.RepositoryInfo.DataDamaged	The VBS repository data is damaged.
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 Repository List