云数据库 RDS

云数据库 RDS

产品文档

云数据库 RDS

帮助中心 > OpenAPI & SDK > 云数据库 RDS > describeBackups
搜本产品

describeBackups

描述

查看该RDS实例下所有备份的详细信息，返回的备份列表按照备份开始时间（backupStartTime）降序排列。

请求方式

GET

请求地址

https://rds.jdcloud-api.com/v1/regions/{regionId}/backups

名称 类型 是否必需 默认值 描述
regionId String True 地域代码，取值范围参见《各地域及可用区对照表》

请求参数

名称 类型 是否必需 默认值 描述
instanceId String True RDS实例ID，唯一标识一个实例
auto Integer False 查询备份类型，0为手动备份，1为自动备份，不传表示全部.
- 测试参数，仅支持SQL Server，后续可能被其他参数取代
backupTypeFilter String False 返回backupType等于指定值的备份列表。full为全量备份，diff为增量备份
- 测试参数，仅支持SQL Server，后续可能被其他参数取代
dbNameFilter String False 返回dbName等于指定值的备份列表，不传或为空返回全部
- 测试参数，仅支持SQL Server，后续可能被其他参数取代
backupTimeRangeStartFilter String False 返回备份开始时间大于该时间的备份列表
- 测试参数，仅支持SQL Server，后续可能被其他参数取代
backupTimeRangeEndFilter String False 返回备份开始时间小于等于该时间的备份列表
- 测试参数，仅支持SQL Server，后续可能被其他参数取代
pageNumber Integer True 显示数据的页码，默认为1，取值范围：[-1,∞)。pageNumber为-1时，返回所有数据页码；超过总页数时，显示最后一页。
pageSize Integer True 每页显示的数据条数，默认为10，取值范围：10、20、30、50、100

返回参数

名称 类型 描述
result Result

Result

名称 类型 描述
backup Backup[ ] 备份集合
totalCount Integer 总记录数

Backup

名称 类型 描述
backupId String 备份ID
backupName String 备份名称，最长支持64个英文字符或等长的中文字符
instanceId String 备份所属实例ID
backupStatus String 备份状态，请查看枚举参数定义
backupStartTime String 备份开始时间，格式为：YYYY-MM-DD HH:mm:ss
backupEndTime String 备份结束时间，格式为：YYYY-MM-DD HH:mm:ss
- SQL Server支持
- MySQL不支持
backupType String 备份类型，全量备份或增量备份，请查看枚举参数定义
- SQL Server支持
- MySQL不支持
backupMode String 备份模式，系统自动备份或手动备份，请查看枚举参数定义
backupUnit String 备份粒度，实例备份或者多库备份，请查看枚举参数定义
- SQL Server支持
- MySQL不支持
backupFiles String[ ] 备份文件列表
- SQL Server支持,备份可以有多个文件，文件名的命名规则为:
（1）全备：数据库名+.bak
（2）增量：数据库名+.diff
- MySQL不支持
backupSizeByte Long 整个备份集大小，单位：Byte

返回码

返回码 描述
200 OK

请求示例

GET

public void testDescribeBackups() {
    DescribeBackupsRequest describeBackupsRequest = new DescribeBackupsRequest();
    describeBackupsRequest.setInstanceId("mysql-wp4e9ztap2");
    describeBackupsRequest.setRegionId("cn-north-1");
    describeBackupsRequest.setPageNumber(1);
    describeBackupsRequest.setPageSize(10);
    DescribeBackupsResponse response = rdsClient.describeBackups(describeBackupsRequest);
    System.out.println(new Gson().toJson(response));
}

返回示例

{
    "requestId": "bpa30g4fdrqkkoe010om8t9rafn4qm43", 
    "result": {
        "backup": [
            {
                "backupId": "0313e588-44d0-4b20-b532-6eebb9d83352", 
                "backupMode": "manual", 
                "backupName": "dj_backup", 
                "backupSizeByte": 15167776, 
                "backupStartTime": "2020-01-07T15:14:07", 
                "backupStatus": "COMPLETED", 
                "instanceId": "mysql-wp4e9ztap2"
            }, 
            {
                "backupId": "dcd25cd6-a787-4fea-8e89-1451ba600591", 
                "backupMode": "auto", 
                "backupName": "916450a3", 
                "backupSizeByte": 15133149, 
                "backupStartTime": "2020-01-07T02:13:03", 
                "backupStatus": "COMPLETED", 
                "instanceId": "mysql-wp4e9ztap2"
            }
        ], 
        "totalCount": 2
    }
}
更新时间：2020-01-19 16:57:34
feedback