API Introduction

View the CSBS Backup Storage Size

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

POST /v4/ecs/backup-usage

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
regionID	Yes	String	Resource pool ID. You can refer to Regions and Availability Zonesto learn more about resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
instanceBackupID	Yes	String	CSBS ID. You can refer toProduct Definition - CSBSto learn more about CSBS. More APIs:Query the CSBS List.	b6e2966d-7b1c-385e-abe4-d940caa273b7

Response Parameter

Parameter	Parameter Type	Description	Example	Lower-level Object
statusCode	Integer	Return status code (800 indicates success, 900 indicates failure). Default value: 800.	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
usage	Integer	Backup storage size (B).	489836016

Sample Request

Request Header

None

Request Body

Example: Query the storage size of a CSBS backup

{

"regionID": "bb9fdb42056f11eda1610242ac110002",

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

}

Response Example

{

"returnObj": {

"usage": 489836016

"message": "SUCCESS",

"description": "Successful",

"statusCode": 800

}

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
Openapi.PatternCheck.NotValid	The request parameter is invalid.
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.EcsBackupParameter.NotValid	The request parameter is invalid.
EcsBackup.BackupCheck.NotFound	The backup is not found.
EcsBackup.Backup.QueryFailed	Failed to query the CSBS backup.

Cloud Server Backup Service

View the Backup Storage Size