文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 备份与恢复/ 查询备份用量总览
更新时间：2026-02-03 GMT+08:00
查看PDF
分享

查询备份用量总览

功能介绍

查询备份用量总览。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:listAll

read

-

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/backups/backup-usage

  • 参数说明
表1 参数说明

参数

是否必选

描述

project_id

是

参数解释：

租户在某一region下的project ID。

约束限制：

非空。

取值范围：

获取方法请参见获取项目ID。

默认取值：

不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

engine

否

String

参数解释：

引擎名称。

约束限制：

只支持筛选RDS for MySQL。

取值范围：

mysql

默认取值：

不涉及。

请求示例

查询备份用量总览。

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

{
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    backup_use_space

    Double

    参数解释：

    备份总使用量，即各类备份占用的备份总大小。单位：MB。

    取值范围：

    不涉及。

    db_use_space

    Double

    参数解释：

    日志备份总使用量，包括本区域的物理全量备份，Binlog日志备份，审计日志。单位：MB。

    取值范围：

    不涉及。

    rds_snapshot_use_space

    Double

    参数解释：

    由RDS计费的CBR快照备份总使用量，单位：MB。

    取值范围：

    不涉及。

    offsite_use_space

    Double

    参数解释：

    跨区域备份总使用量，包括跨区域的物理全量备份，Binlog日志备份。单位：MB。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
    "backup_use_space":800, 
    "db_use_space":300, 
    "rds_snapshot_use_space":400, 
    "offsite_use_space":100
}

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档