# 查询共享备份列表 - ListShareBackups #### 功能介绍 查询共享备份列表。 - 调用接口前，您需要了解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://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListShareBackups)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:backup:listSharedResources | list | - | - | - | - | #### 接口约束 - 该接口仅支持PostgreSQL引擎。 - 如需使用该接口，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。 #### URI - URI格式 GET /v3/{project_id}/share-backups - 参数说明 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 否 | String | **参数解释：** 实例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"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_name | 否 | String | **参数解释：** 实例名称。 可调用[查询数据库实例列表](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)中的"name"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | backup_name | 否 | String | **参数解释：** 备份名称。 可调用[获取备份列表](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)中的"name"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值** **：** 默认为0，即偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值** **：** 100 | #### 请求消息 无。 #### 请求示例 查询共享备份列表。 ``` GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/share-backups?offset=1&limit=10 ``` #### 响应消息 - 正常响应要素说明 表2参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | backups | Array of objects | **参数解释：** 备份列表。 详情请参见[表3]。 | | total | Long | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | 表3backups字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 备份名称。 **取值范围：** 不涉及。 | | begin_time | String | **参数解释：** 备份开始时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | end_time | String | **参数解释：** 备份结束时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | status | String | **参数解释：** 备份状态。 **取值范围：** - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 - DELETING：备份删除中。 | | size | Double | **参数解释：** 备份大小，单位：KB。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 备份类型。 **取值范围：** - Snapshot：手动备份。 - Db：自动备份。 - Log：日志备份。 - OffSiteDb：跨区域自动备份。 - OffSiteLog：跨区域日志备份。 - SnapshotDatabaseBackup：手动表级备份。 | | backup_method | String | **参数解释：** 备份方法。 **取值范围：** - Physics：物理备份。 - Snapshot：快照备份。 | | instance_id | String | **参数解释：** 备份所在实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 备份所在实例名称。 **取值范围：** 不涉及。 | | instance_status | String | **参数解释：** 备份所在实例状态。 **取值范围：** - normal：表示实例正常。 - deleted：表示实例已经被删除。 - shutdown：表示实例处于停止状态。 - abnormal：表示实例异常。 - data_disk_full：表示实例磁盘空间满。 | | datastore | Object | **参数解释：** 数据库版本信息。 详情请参见[表4]。 | | user_name | String | **参数解释：** 共享备份信息的账号名。 **取值范围：** 不涉及。 | 表4datastore字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库引擎，不区分大小写。 **取值范围：** postgresql | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "backups": [ { "id": "5f7e53404b544905ae5072bb9b99104fbr03", "name": "backup-303e", "begin_time": "2023-08-06T12:41:14+0800", "end_time": "2023-08-06T12:43:14+0800", "status": "COMPLETED", "size": 3668.963868, "type": "Snapshot", "backup_method": "Physics", "instance_id": "ff8d322bbeb144369459e95882941d7ain03", "instance_name": "rds-cc71", "instance_status": "deleted", "datastore": { "type": "postgresql", "version": "15.4.0" }, "user_name": "cloud_3536" }, { "id": "d2cc77f83a5c4ad2a7a73b493afbd20dbr03", "name": "backup-c918", "begin_time": "2023-08-06T12:41:14+0800", "end_time": "2023-08-06T12:43:14+0800", "status": "COMPLETED", "size": 3925.561524, "type": "Snapshot", "backup_method": "Physics", "instance_id": "56074f3b56bb4bbabbb73c8f0797d3fdin03", "instance_name": "rds-5f45", "instance_status": "deleted", "datastore": { "type": "postgresql", "version": "14.6.1" }, "user_name": "cloud_3536" } ] "total": 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)。