API Introduction

Query the CSBS Backup List

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.

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 refer toRegions and Availability Zonesto learn more about resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
pageNo	No	Integer	Page number. Value range: Positive integer (≥1). Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Value range: [1, 50]. Default value: 10.	10
instanceID	No	String	Cloud server ID. You can refer toECSto learn more about cloud servers. More APIs:Query the Cloud Server List,Create a Subscription-based or Pay-as-you-go Cloud Server, andCreate Subscription-based or Pay-as-you-go Cloud Servers in Batch.	de70ef00-1ea0-459a-b74d-b06272561a32
repositoryID	No	String	CSBS repository ID. You can refer toProduct Definition - Repositoriesto learn more about repositories. More APIs:Query the Repository ListandCreate a Repository.	de70ef00-1ea0-459a-b74d-b06272561a32
instanceBackupID	No	String	CSBS backup ID. You can refer toProduct Definition - CSBSto learn more about CSBS. More APIs:Query the CSBS Backup ListandCreate a CSBS Backup.	ed48dc25-d6bb-48e6-b202-3e36ee6321a3
queryContent	No	String	Query content using fuzzy match. Fields: instanceBackupName, instanceBackupID, instanceBackupStatus, and instanceName.	backup-test01
instanceBackupStatus	No	String	CSBS backup status.	ACTIVE
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

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	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
instanceBackupID	String	CSBS backup ID.	ed48dc25-d6bb-48e6-b202-3e36ee6321a3
instanceBackupName	String	CSBS backup name.	auto-2-0002
instanceBackupStatus	String	CSBS backup status. Value range: CREATING, ACTIVE, RESTORING, DELETING, EXPIRED, and ERROR.	ACTIVE
instanceBackupDescription	String	CSBS backup description.	auto backup
instanceID	String	Cloud server ID.	de70ef00-1ea0-459a-b74d-b06272561a32
instanceName	String	Cloud Server Name	ecm-9014
repositoryID	String	CSBS repository ID.	986035b0-7862-4a1c-b020-3c2cef81dd6d
repositoryName	String	CSBS repository name.	repo-test01
repositoryExpired	Boolean	Indicate whether the CSBS repository has expired.	false
repositoryFreeze	Boolean	Indicate whether the CSBS repository is frozen.	false
diskTotalSize	Integer	Total disk capacity (GB).	100
usedSize	Integer	Occupied disk capacity.	10
diskCount	Integer	Disk quantity.	1
restoreFinishedTime	String	Backup restoration completed at	2023-07-24T04:10:02Z
createdTime	String	Created At	2023-07-24T04:00:10Z
finishedTime	String	Completed On	2023-07-24T04:00:10Z
projectID	String	Enterprise project ID.	0

Sample Request

Request Header

None

Request Body

Example: Query the CSBS backup list in the specific repository

    "regionID": "bb9fdb42056f11eda1610242ac110002",

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

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

Response Example

                  "returnObj": {

                                     "currentCount": 2,

                                     "totalCount": 41,

                                     "totalPage": 21,

                                     "results": [{

                                                       "instanceBackupID": "58b42997-4f95-bf60-85af-17a8e80242e6",

                                                       "instanceBackupName": "openapi-test9",

                                                       "instanceBackupDescription": "openapi test9",

                                                       "instanceBackupStatus": "ACTIVE",

                                                       "instanceID": "b3721e53-7d5c-52d4-4572-581b5abe7807",

                                                       "instanceName": null,

                                                       "repositoryID": "353026fc-ed30-47b0-ab8a-62717a6919d6",

                                                       "repositoryName": "repo-f1b0",

                                                       "diskTotalSize": 45,

                                                       "usedSize": 0,

                                                       "restoreFinishedTime": null,

                                                       "diskCount": 0,

                                                       "createdTime": "2023-01-10T02:16:26Z",

                                                       "finishedTime": null,

                                                       "projectID": "0",

                                                       "repositoryFreeze": false,

                                                       "repositoryExpired": false

                                     }, {

                                                       "instanceBackupID": "df8dacda-7f76-6d1d-546a-f16e0c0bd005",

                                                       "instanceBackupName": "manualbk-z4s7",

                                                       "instanceBackupDescription": "manual backup",

                                                       "instanceBackupStatus": "ACTIVE",

                                                       "instanceID": "142dcec0-31c4-1f50-708a-43a7edb94a52",

                                                       "instanceName": null,

                                                       "repositoryID": "f5b4d335-d36b-4dd6-b3a0-bca28b4d33ab",

                                                       "repositoryName": "repo-55cf",

                                                       "diskTotalSize": 45,

                                                       "usedSize": 819598338,

                                                       "restoreFinishedTime": null,

                                                       "diskCount": 2,

                                                       "createdTime": "2023-02-01T04:46:44Z",

                                                       "finishedTime": "2023-02-01T04:58:42Z",

                                                       "projectID": "0",

                                                       "repositoryFreeze": false,

                                                       "repositoryExpired": 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.
Openapi.PatternCheck.NotValid	The request parameter is invalid.
Ecs.PatternCheck.SortNotValid	The sorting parameter is invalid.
EcsBackup.WorkOrder.QueryFail	Failed to query the CSBS backup.

Cloud Server Backup Service