# 查询回收站实例列表 - QueryingInstancesintheRecycleBin #### 功能介绍 查询回收站所有接口的实例列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ListRecycleInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:listRecycleInstances | List | - | - | nosql:instance:list | - | #### URI GET /v3/{project_id}/recycle-instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 索引位置偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 大于或等于0。 **取值范围：** 不涉及。 **默认取值：** 0，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 100。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | instances | Array of [表5] objects | **参数解释：** 实例信息。 | 表5RecycleInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | mode | String | **参数解释：** 实例类型。 **取值范围：** - 取值为"Cluster"，表示GeminiDB Cassandra经典部署模式集群实例类型、GeminiDB Influx经典部署模式集群实例类型、GeminiDB Redis经典部署模式Proxy集群实例类型、GeminiDB兼容DynamoDB经典部署模式集群实例类型。 - 取值为"CloudNativeCluster"，表示GeminiDB Cassandra云原生部署模式集群实例类型、GeminiDB Influx云原生部署模式集群实例类型、GeminiDB Redis云原生部署模式集群实例类型、GeminiDB兼容DynamoDB云原生部署模式集群实例类型。 - 取值为"RedisCluster"，表示GeminiDB Redis经典部署模式Cluster集群实例类型。 - 取值为"Replication"，表示GeminiDB Redis经典部署模式主备实例类型。 - 取值为"InfluxdbSingle"，表示GeminiDB Influx 经典部署模式单节点实例类型。 - 取值为"ReplicaSet"，表示GeminiDB MongoDB副本集实例类型。 | | product_type | String | **参数解释：** 产品类型。 GeminiDB Redis云原生部署模式集群涉及此字段。 **取值范围：** Capacity：容量型。 | | data_store | [表6] object | **参数解释：** 数据库信息。 | | charge_type | String | **参数解释：** 计费方式。 **取值范围：** - prePaid：预付费，即包年/包月。 - postPaid：后付费，即按需付费。 | | enterprise_project_id | String | **参数解释：** 企业项目ID，取值为"0"，表示为default企业项目。 **取值范围：** 不涉及。 | | backup_id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | created_at | String | **参数解释：** 实例创建时间，UTC时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | deleted_at | String | **参数解释：** 实例删除时间，UTC时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | retained_until | String | **参数解释：** 回收备份保留截止时间，UTC时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | 表6RecycleDatastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库类型。 **取值范围：** - 取值为"cassandra"，表示GeminiDB Cassandra数据库实例。 - 取值为"mongodb"，表示GeminiDB Mongo数据库实例。 - 取值为"influxdb"，表示GeminiDB Influx数据库实例。 - 取值为"redis"，表示GeminiDB Redis数据库实例。 - 取值为"dynamodb"，表示GeminiDB兼容DynamoDB数据库实例。 | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | #### 请求示例 URI样例 ``` GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances?offset=0&limit=100 ``` #### 响应示例 **状态码： 200** Success. ``` { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", "name" : "test", "mode" : "Cluster", "data_store" : { "type" : "cassandra", "version" : "3.11" }, "charge_type" : "postPaid", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T11:00:00", "retained_until" : "2022-02-02T11:00:00" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。