Querying the Backup Usage Overview

This API is used to query the backup usage overview.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	*Resource Type (: required)**	Condition Key	Alias	Dependencies
rds:instance:listAll	read	-	-	rds:instance:list	-

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A

**Table 2** Parameters
Parameter	Mandatory	Type	Description
engine	No	String	Definition DB engine name. Constraints Only RDS for MySQL is supported. Range mysql Default Value N/A

Query the backup usage overview.

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/backups/backup-usage?engine=mysql

{
}

Normal response

**Table 3** Parameters
Parameter	Type	Description
backup_use_space	Double	Definition Total space usage of backups (in MB), that is, the total size of all backups. Range N/A
db_use_space	Double	Definition Total space usage of log backups (in MB), including physical full backups, binlog backups, and audit logs in the current region. Range N/A
rds_snapshot_use_space	Double	Definition Total space usage of CBR snapshot backups billed by RDS, in MB. Range N/A
offsite_use_space	Double	Definition Total space usage of cross-region backups (in MB), including physical full backups and binlog backups in target regions. Range N/A

Example normal response

{
    "backup_use_space":800, 
    "db_use_space":300, 
    "rds_snapshot_use_space":400, 
    "offsite_use_space":100
}

For details, see Error Codes.

Parent topic: Backup and Restoration

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.