# 查询回收站实例列表-QueryingDBInstancesintheRecycleBin #### 接口说明 查询回收站实例列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListRecycleInstances)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:listRecycleInstances | list | - | - | dds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/recycle-instances - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances 表1请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 **约束限制：** 必须为数字，不能为负数。 **取值范围：** 不涉及。 **默认取值：** 0。 | | limit | 否 | Integer | **参数解释：** 每页显示的数量。 **约束限制：** 必须为数字，不能为负数。 **取值范围：** 不涉及。 **默认取值：** 100。 | #### 请求消息 无。 #### 响应消息 - 参数说明 表3响应Body参数 | 参数 | 参数类型 | 说明 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | instances | Array of [表4] objects | **参数解释：** 实例信息。 **取值范围：** 不涉及。 | 表4RecycleInstance | 参数 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | mode | String | **参数解释：** 实例类型。支持集群、副本集、以及单节点。 **取值范围：** - Sharding：表示集群。 - ReplicaSet：表示副本集。 - Single：表示单节点。 | | datastore | [表5] object | **参数解释：** 数据库信息。 **取值范围：** 不涉及。 | | pay_mode | String | **参数解释：** 计费方式。 **取值范围：** - 取值为"0"，表示按需计费。 - 取值为"1"，表示包年/包月计费。 | | enterprise_project_id | String | **参数解释：** 企业项目ID，取值为"0"，表示为default企业项目。 **取值范围：** 不涉及。 | | backup_id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | created_at | String | **参数解释：** 创建时间。 **取值范围：** 不涉及。 | | deleted_at | String | **参数解释：** 删除时间。 **取值范围：** 不涉及。 | | retained_until | String | **参数解释：** 保留截止时间。 **取值范围：** 不涉及。 | 表5RecycleDatastore | 参数 | 参数类型 | 说明 | |:---|:---|:---| | type | String | **参数解释：** 数据库版本类型。 **取值范围：** 取值"DDS-Community"。 | | version | String | **参数解释：** 数据库版本。支持3.4、4.0、4.2、4.4和5.0版本。 **取值范围：** 取值为"3.4"、"4.0"或"4.2"、"4.4"、"5.0"。 | #### 请求示例 ``` GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances?offset=0&limit=100 ``` #### 响应示例 **状态码：200** Success. ``` { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in02", "name" : "test1", "mode" : "ReplicaSet", "datastore" : { "type" : "DDS-Community", "version" : "4.0" }, "pay_mode" : "0", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T10:00:00", "retained_until" : "2022-05-01T10:00:00" } ] } ``` #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。