文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 查询回收站实例信息- ListRecycleInstances
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询回收站实例信息 - ListRecycleInstances

功能介绍

查询回收站实例信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:list

    List

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/instances/recycle-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100。

默认取值：

100。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0。

默认取值：

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

String

参数解释：

数据总数。

取值范围：

不涉及。

instances

Array of RecycleInstanceV3 objects

参数解释：

回收站实例信息列表。
表5 RecycleInstanceV3

参数

参数类型

描述

id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

name

String

参数解释：

实例名称。

取值范围：

最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。

ha_mode

String

参数解释：

实例类型。

取值范围：

不涉及。

engine_name

String

参数解释：

引擎名称。

取值范围：

不涉及。

engine_version

String

参数解释：

引擎版本。

取值范围：

不涉及。

pay_model

String

参数解释：

计费模式。

取值范围：

不涉及。

create_at

Integer

参数解释：

创建时间。

取值范围：

不涉及。

deleted_at

Integer

参数解释：

删除时间。

取值范围：

不涉及。

volume_type

String

参数解释：

磁盘类型。

取值范围：

  • POOL：DL6

  • POOL-EXT：DL6（增程版）

  • STANDARDPOOL：DL5

  • STANDARDPOOL-EXT：DL5（增程版）

  • NORMALPOOL：DL4

  • COLDPOOL：冷存储

volume_size

String

参数解释：

磁盘大小。

取值范围：

不涉及。

data_vip

String

参数解释：

数据面VIP。

取值范围：

不涉及。

data_vip_ipv6

String

参数解释：

数据面IPV6。

取值范围：

不涉及。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

enterprise_project_name

String

参数解释：

企业项目名称。

取值范围：

不涉及。

backup_level

String

参数解释：

备份级别。

取值范围：

不涉及。

recycle_backup_id

String

参数解释：

备份ID。

取值范围：

不涉及。

recycle_status

String

参数解释：

回收状态。

取值范围：

  • Active：二级备份可用。

  • Available：一级备份可用。

  • Running：回收站实例正在备份中。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询回收站实例信息

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-info

响应示例

状态码： 200

Success.

{
  "total_count" : 2,
  "instances" : [ {
    "id" : "090e539b45e047ee9cc17750b321ef7ein07",
    "name" : "gauss-dd-single",
    "ha_mode" : "StandSingle",
    "engine_name" : "taurus",
    "engine_version" : "2.0.51.240300",
    "pay_model" : "0",
    "create_at" : 1712656933705,
    "deleted_at" : 1712659228276,
    "volume_type" : "",
    "volume_size" : "0",
    "data_vip" : "172.16.1.234",
    "data_vip_ipv6" : null,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "backup_level" : "2",
    "recycle_backup_id" : "c62e218ccd6c49098baa925453c65e29br07",
    "recycle_status" : "Active"
  }, {
    "id" : "632423cc56c348bd967b3a03e7abdab9in07",
    "name" : "gauss-dd-single",
    "ha_mode" : "StandSingle",
    "engine_name" : "taurus",
    "engine_version" : "2.0.51.240300",
    "pay_model" : "0",
    "create_at" : 1712658210524,
    "deleted_at" : 1712659158927,
    "volume_type" : "",
    "volume_size" : "0",
    "data_vip" : "172.16.1.194",
    "data_vip_ipv6" : null,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "backup_level" : "2",
    "recycle_backup_id" : "70d03dc459304f7298c0f5b49286f37cbr07",
    "recycle_status" : "Active"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理