API Introduction

Query the disk size of a CSBS backup.

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.

2. The cloud server must be an existing one.

URI

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

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
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
instanceID	Yes	String	Cloud server ID. You can refer toECSto learn more about cloud servers. More APIs:Query the Cloud Server List.	69aac66c-78e8-e704-e6e1-311b3f40a278

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.	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
totalDiskSize	Integer	Cloud server disk usage, in GB.	45

Sample Request

Example: Query the total disk capacity of a cloud server

GET '.../v4/ecs/backup/statistics?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=69aac66c-78e8-e704-e6e1-311b3f40a278'

Request Header

None

Request Body

None

Response Example

                  "returnObj": {

                                     "totalDiskSize": 45

},

                  "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.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
Ecs.Instance.NotFound	The cloud server is not found. Check whether the cloud server ID is correct.
EcsBackup.WorkOrder.QueryFail	Failed to obtain the CSBS backup.

Cloud Server Backup Service

Query the Disk Size of a CSBS Backup