# 获取备份列表 - ListBackups #### 功能介绍 获取备份列表。 #### 接口约束 该接口支持查询全量和增量备份。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:backup:list | list | - | - | - | - | #### URI - URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}\&backup_id={backup_id}\&backup_type={backup_type}\&offset={offset}\&limit={limit}\&begin_time={begin _time}\&end_time={end_time} - 参数说明 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-flexusrds/rds_03_0002.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | backup_id | 否 | String | **参数解释**： 备份ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | backup_type | 否 | String | **参数解释**： 备份类型。 **约束限制**： 不涉及。 **取值范围**： - "auto"：自动全量备份。 - "manual"：手动全量备份。 - "fragment"：差异全量备份。 - "incremental"：自动增量备份。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 备份状态。 **约束限制**： 不涉及。 **取值范围**： - "BUILDING"：备份中。 - "COMPLETED"：备份完成。 - "FAILED"：备份失败。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 索引位置，偏移量。 **约束限制**： 不涉及。 **取值范围**： 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 不涉及。 **取值范围**： 默认为100，不能为负数，最小值为1，最大值为100。 **默认取值**： 100 | | begin_time | 否 | String | **参数解释**： 查询开始时间。 **约束限制**： "begin_time"有值时，"end_time"必选。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **默认取值**： 不涉及。 | | end_time | 否 | String | **参数解释**： 查询结束时间。 **约束限制**： "end_time"有值时，"begin_time"必选。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **默认取值**： 不涉及。 | #### 请求参数 无。 #### 请求示例 ``` GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800 ``` #### 响应消息 - 正常响应要素说明 表2要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | backups | Array of objects | **参数解释：** 备份列表。详情请参见[表3]。 | | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | 表3backups字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 备份名称。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 备份类型。 **取值范围：** - "auto"：自动全量备份。 - "manual"：手动全量备份。 - "fragment"：差异全量备份。 - "incremental"：自动增量备份。 | | size | Long | **参数解释：** 备份大小，单位：KB。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 备份状态。 **取值范围：** - BUILDING: 备份中。 - COMPLETED: 备份完成。 - FAILED：备份失败。 - DELETING：备份删除中。 | | begin_time | String | **参数解释：** 备份开始时间。 - 全量备份类型下，指备份开始时间。 - 增量备份类型，指备份文件中上一轮增备任务的最后一个事务的提交时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | end_time | String | **参数解释：** 备份结束时间。 - 全量备份类型下，指备份结束时间。 - 增量备份类型，指备份文件中最后一个事务的提交时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | datastore | Object | **参数解释：** 数据库版本信息。详情请参见[表4]。 | | instance_id | String | **参数解释：** 备份所在实例ID。 **取值范围：** 不涉及。 | | associated_with_ddm | Boolean | **参数解释：** 是否已被DDM实例关联。 **取值范围：** 不涉及。 | 表4datastore字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | type | String | **参数解释：** 数据库引擎。 **取值范围：** MySQL | | version | String | **参数解释：** 数据库版本。 **取值范围：** 5.7、8.0 | - 正常响应样例 ``` { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } ``` - 异常响应 请参见[异常请求结果](https://support.huaweicloud.com/api-flexusrds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-flexusrds/rds_10_0200.html)。