API Introduction

Query the storage size of a VBS backup.

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/usage</span>

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
backupID	Yes	String	VBS backup ID.	59093d15-8a3c-53b9-b61b-484af10a3e97

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
usedSize	Yes	Integer	VBS backup size (byte).	1024000

Sample Request

Request Header

None

Request Body

None

Response Example

    "statusCode": 800,

    "message": "SUCCESS",

    "description": "Successful",

    "returnObj": {

        "usedSize": 10

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.BackupInfo.Empty	The VBS backup is empty.
EbsBackup.BackupInfo.NotFound	The VBS backup is not found.
EbsBackup.BackupInfo.AccessFailed	Failed to query the backup.
EbsBackup.BackupInfo.DataDamaged	The VBS backup data is incorrect.
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.

Volume Backup Service

Query the Backup Storage Size