# 查询回收站实例信息 - ListRecycleInstances #### 功能介绍 查询回收站实例信息。 - 调用接口前，您需要了解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=ListRecycleInstances)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:listAll | read | - | - | rds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/recycle-instances?offset={offset}\&limit={limit} - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 是 | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0的整数。 **默认取值**： 不涉及。 | | limit | 是 | **参数解释**： 每页数据条数。 **约束限制**： 不涉及。 **取值范围**： \[1, 50\] **默认取值**： 不涉及。 | #### 请求消息 - 参数说明 无。 - URI样例 GET https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/recycle-instances?offset=0\&limit=10 #### 响应消息 - 正常响应要素说明 表2要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | total_count | Integer | **参数解释**： 回收站数据条数。 **取值范围**： 不涉及。 | | instances | Array of objects | **参数解释**： 回收站信息，详细说明请参见[表3]。 | 表3instances字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | | ha_mode | String | **参数解释**： 实例主备模式。 **取值范围**： 不区分大小写。 - Single：单机实例。 - Ha：主备实例。 - Cluster：集群版实例。 | | engine_name | String | **参数解释**： 引擎名称。 **取值范围**： 不涉及。 | | engine_version | String | **参数解释**： 数据库引擎版本。 **取值范围**： 不涉及。 | | pay_model | String | **参数解释**： 计费方式。 **取值范围**： 0：按需计费。 1：包周期计费。 | | created_at | String | **参数解释**： 创建时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 | | deleted_at | String | **参数解释**： 删除时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 | | volume_type | String | **参数解释**： 磁盘类型。 **取值范围**： - ULTRAHIGH，表示超高IO型磁盘。 - ULTRAHIGHPRO，表示SSD尊享版，仅支持超高性能型尊享版（需申请权限）。 - CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 - LOCALSSD，表示本地SSD盘。 | | volume_size | Integer | **参数解释**： 磁盘大小。 **取值范围**： - 对于MySQL引擎：单机和主备实例是20GB\~10000GB，集群版实例是20GB\~4000GB，必须为10的整数倍。 - 对于PostgreSQL引擎：40GB\~4000GB，必须为10的整数倍。 - 对于SQL Server引擎：40GB\~10000GB，必须为10的整数倍。 - 对于只读实例，该参数无效，只读实例磁盘大小默认和主实例相同。 | | data_vip | String | **参数解释**： 内网地址。 **取值范围**： 不涉及。 | | data_vip_v6 | String | **参数解释**： IPv6内网地址。 **取值范围**： 不涉及。 | | enterprise_project_id | String | **参数解释**： 企业项目ID。 **取值范围**： 不涉及。 | | retained_until | String | **参数解释**： 保留时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 | | recycle_backup_id | String | **参数解释**： 备份ID。 **取值范围**： 不涉及。 | | recycle_status | String | **参数解释**： 备份状态。 **取值范围**： - BUILDING：备份中，不能进行重建。 - COMPLETED：备份完成，可以重建实例。 | | is_serverless | Boolean | **参数解释**： 实例类型。 **取值范围**： - true：表示Serverless实例。 - false：表示非Serverless实例。 | - 正常响应样例 ``` { "total_count" : 2, "instances" : [ { "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", "name" : "rds-8b86", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T03:38:10+0000", "deleted_at" : "2023-01-09T08:57:10+0000", "volume_type" : "SSD", "volume_size" : 80, "data_vip" : "192.168.226.188", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:48+0000", "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", "recycle_status" : "COMPLETED", "is_serverless" : false }, { "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", "name" : "rds-82b2", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T06:17:58+0000", "deleted_at" : "2023-01-09T08:56:49+0000", "volume_type" : "SSD", "volume_size" : 200, "data_vip" : "192.168.2.24", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:45+0000", "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", "recycle_status" : "COMPLETED", "is_serverless" : false } ] } ``` - 异常响应 请参见[异常响应结果](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)。