文档首页/ 云数据库 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

默认取值：

不涉及。

order_field

否

String

参数解释：

根据指定字段排序查询结果。

约束限制：

不涉及。

取值范围：

  • backup_used_space：根据备份数据总量排序。
  • obs：根据日志备份用量排序。

默认取值：

不涉及。

order_rule

否

String

参数解释：

排序规则。

约束限制：

不涉及。

取值范围：

  • ASC：根据排序字段升序。
  • DESC：根据排序字段降序。

默认取值：

DESC

instance_id

String

否

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

默认取值：

不涉及。

instance_name

String

否

参数解释：

实例名称，支持模糊匹配。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

Integer

否

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

不涉及。

取值范围：

大于等于0的整数。

默认取值：

0

limit

Integer

否

参数解释：

查询记录数。

约束限制：

不涉及。

取值范围：

不能为负数，最小值为1，最大值为50。

默认取值：

10

请求示例

查询实例备份用量列表。

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

{
}

响应消息

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

    名称

    参数类型

    说明

    infos

    Array of Object

    参数解释：

    实例备份概览列表，详见表4。

    total_count

    Integer

    参数解释：

    总记录数。

    取值范围：

    不涉及。
    表4 infos字段说明

    名称

    参数类型

    说明

    id

    String

    参数解释：

    实例ID。

    取值范围：

    不涉及。

    name

    String

    参数解释：

    实例名称。

    取值范围：

    不涉及。

    backup_use_space

    Double

    参数解释：

    备份数据总量，包括日志备份用量和快照备份用量。单位：MB。

    取值范围：

    不涉及。

    datastore

    Object

    参数解释：

    数据库引擎信息，详见表5。

    spaces

    Object

    参数解释：

    备份用量详情，详见表6。
    表5 datastore字段说明

    名称

    参数类型

    说明

    type

    String

    参数解释：

    数据库引擎类型。

    取值范围：

    不涉及。

    version

    String

    参数解释：

    数据库引擎版本。

    取值范围：

    不涉及。
    表6 spaces字段说明

    名称

    参数类型

    说明

    obs

    Double

    参数解释：

    日志备份用量，单位：MB。

    取值范围：

    不涉及。

    snapshot

    Double

    参数解释：

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

    取值范围：

    不涉及。

    obs_free

    Double

    参数解释：

    日志备份赠送空间，单位：GB。

    取值范围：

    不涉及。

    snapshot_free

    Double

    参数解释：

    快照备份赠送空间，单位：GB。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
    "infos": [
        {
            "instance_id": "3c96029500994cba823e3e9faa557c03in01",
            "name": "rds-test",
            "backup_used_space": 2308.01,
            "space": {
                "obs": 0.01,
                "snapshot": 2308.0,
                "obs_free": 100.0,
                "snapshot_free": 300.0
            },
            "datastore": {
                "type": "mysql",
                "version": "8.0.41"
            }
        }
    ],
    "total": 1
}

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档