# 查询跨区域备份列表 - ListOffSiteBackups #### 功能介绍 在备份目标区域获取实例的跨区域备份列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=ListOffSiteBackups)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:backup:list | list | - | - | - | - | #### 接口约束 RDS for SQL Server支持查询备份类型为自动全量备份、手动备份、自动增量备份的备份列表。 #### URI - URI格式 GET /v3/{project_id}/offsite-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 | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 源区域下的实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | backup_type | 是 | **参数解释：** 备份类型。 **约束限制：** 不涉及。 **取值范围：** - auto：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 - incremental：自动增量备份。 **默认取值：** 不涉及。 | | backup_id | 否 | **参数解释：** 源区域下的备份ID。 可调用[获取备份列表](https://support.huaweicloud.com/api-rds/rds_09_0005.html)接口，通过[表3](https://support.huaweicloud.com/api-rds/rds_09_0005.html#rds_09_0005__table52869820)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0。偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 100 | | begin_time | 否 | **参数解释：** 查询开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **约束限制：** "begin_time"有值时，"end_time"必选。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | end_time | 否 | **参数解释：** 查询结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **约束限制：** "end_time"有值时，"begin_time"必选。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 - 请求参数 无。 - URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/offsite-backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01\&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：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 - incremental：自动增量备份。 | | size | Long | **参数解释：** 备份大小（单位：KB）。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 备份状态。 **取值范围：** - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 - DELETING：备份删除中。 | | databases | Array of objects | **参数解释：** 用户自建库，仅RDS for SQL Server返回该字段。 详情请参见[表4]。 | | begin_time | String | **参数解释：** 备份开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 备份结束时间。 - 全量备份类型下，指备份结束时间。 - RDS for MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 格式为"yyyy-mm-ddThh:mm:ssZ"，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | datastore | Object | **参数解释：** 数据库版本信息。 详情请参见[表5]。 | | instance_id | String | **参数解释：** 备份所在实例ID。 **取值范围：** 不涉及。 | | associated_with_ddm | Boolean | **参数解释：** 是否关联DDM标志。仅RDS for MySQL返回该字段。 **取值范围：** - true：关联。 - false：不关联。 | 表4databases字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | name | String | **参数解释：** 用户自建数据库名。 **取值范围：** 不涉及。 | 表5datastore字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | type | String | **参数解释：** 数据库引擎。 **取值范围：** - MySQL - PostgreSQL - sqlserver | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | - 正常响应样例 **MySQL：** ``` { "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.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } ``` **PostgreSQL：** ``` { "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": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 } ``` **SQL Server：** ``` { "backups": [ { "id": "d0ea632a5c32451dbdb157ef5c2ad3ecbr04", "name": "sqlserver-rds-1784-20221202062025775", "type": "auto", "size": 5956, "status": "COMPLETED", "begin_time": "2022-12-02T06:20:25+0000", "end_time": "2022-12-02T06:24:45+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" }, { "id": "07d6a8ab12304f9aa3f368a6cff21ac9br04", "name": "backup-81f1", "type": "auto", "size": 773, "status": "COMPLETED", "begin_time": "2022-12-02T06:12:22+0000", "end_time": "2022-12-02T06:16:37+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" } ], "total_count": 2 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。