API Introduction

Query the CSBS backup repositories based on the filter parameters.

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

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.

URI

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

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource pool ID. You can refer toRegions and Availability Zonesto learn more about the resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
projectID	No	String	Enterprise project ID. The enterprise project management feature allows you to manage resource by enterprise project and manage resources and members within each project.	0
repositoryName	No	String	Repository name. Only digits, letters, and hyphen (-) are allowed. The name cannot start with a digit or a hyphen (-) or end with a hyphen (-). It must be within 2 to 63 characters in length.	test-repo
repositoryID	No	String	Repository ID. You can refer toProduct Definition - Repositoriesto learn more about repositories. More APIs:Query the Repository ListandCreate a Repository.	9915c3f4-8d78-445a-a1da-d8d9287d506b
status	No	String	Repository status.	active
pageNo	No	Integer	Page number. Value range: Positive integer (≥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.	5

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.	Refer to error codes
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	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
regionID	String	Resource Pool ID	bb9fdb42056f11eda1610242ac110002
repositoryID	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
projectID	String	Enterprise project ID.	0
repositoryName	String	Repository Name	test-repo
status	String	Repository status, including expired and active. Available	active
size	Integer	Total repository capacity (GB).	100
freeSize	Integer	Available repository capacity (GB).	90
usedSize	Integer	Occupied repository capacity (byte).	10240000000
createdAt	String	Created At	"2023-02-10T09:32:36Z"
expiredAt	String	Expiration Time	"2023-03-10T09:32:54Z"
expired	Boolean	Indicate whether the repository is expired.	false
freeze	Boolean	Indicate whether the repository is frozen.	false
paas	Boolean	Indicate whether PAAS is supported.	false
backupList	Array of Strings	IDs of available backups in the repository.	["59093d15-8a3c-53b9-b61b-484af10a3e97"]
backupCount	Integer	Number of backups in the repository.	2

Sample Request

Request URL

Example: Query CSBS repository list in East 1

GET '.../v4/ecs/backup-repo/list?regionID=bb9fdb42056f11eda1610242ac110002'

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "currentCount": 1,

        "totalCount": 17,

        "totalPage": 17,

        "results": [

                "regionID": "bb9fdb42056f11eda1610242ac110002",

                "projectID": 0,

                "backupList": [],

                "paas": false,

                "freeze": false,

                "backupCount": 0,

                "repositoryID": "7d7a9c15-1460-4912-84a5-0ade4bc9a526",

                "repositoryName": "cbr-test-openapi",

                "status": "active",

                "size": 100,

                "freeSize": 100.0,

                "usedSize": 0,

                "createdAt": "2023-02-10T09:32:36Z",

                "expiredAt": "2023-03-10T09:32:54Z",

                "expired": false

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.RegionInfo.AccessFailed	Failed to query the resource pool.
EcsBackup.RegionInfo.DataDamaged	The resource pool information is damaged.
EcsBackup.RepositoryInfo.NotFound	The repository is not found.

Cloud Server Backup Service

Query the CSBS Repository List