更新时间:2026-04-03 GMT+08:00

查询回收站实例列表

功能介绍

查询回收站实例列表。

URI

GET /v2/{project_id}/recycle

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

retention_days

Integer

参数解释:

保留天数。

约束限制:

不涉及。

取值范围:

1~7。

默认取值:

不涉及。

default_use_recycle

Boolean

参数解释:

是否使用回收站。

约束限制:

不涉及。

取值范围:

  • true:使用回收站。

  • false:不使用回收站。

默认取值:

不涉及。

recycle_instances

Array of InstanceRecycleInfo objects

参数解释:

回收实例列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 InstanceRecycleInfo

参数

参数类型

描述

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

String

参数解释:

实例状态。

约束限制:

不涉及。

取值范围:

详细状态说明请参考实例状态说明。

默认取值:

不涉及。

name

String

参数解释:

实例名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

engine

String

参数解释:

消息引擎。

约束限制:

不涉及。

取值范围:

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值:

不涉及。

in_recycle_time

Long

参数解释:

回收时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

save_time

Integer

参数解释:

保留时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

取值范围:

1~7。

auto_delete_time

Long

参数解释:

自动删除时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cost_per_hour

Double

参数解释:

每小时的费用。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

error_message

String

参数解释:

错误信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

product_id

String

参数解释:

产品ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

查询回收站实例列表。

GET https://{endpoint}/v2/{project_id}/recycle

响应示例

状态码:200

查询回收站实例列表成功。

{
  "retention_days" : "2,",
  "default_use_recycle" : "true,",
  "recycle_instances" : [ {
    "instance_id" : "9b6b7173-d1d8-4604-86a8-43b732715a05,",
    "status" : "ERROR,",
    "name" : "rocketmq-cwx1445495-001,",
    "engine" : "reliability,",
    "in_recycle_time" : "1763450761139,",
    "save_time" : "2,",
    "auto_delete_time" : "1763623561139,",
    "cost_per_hour" : "0.0,",
    "error_message" : "null,",
    "product_id" : "c6.32u128g.cluster.x86"
  } ]
}

状态码

状态码

描述

200

查询回收站实例列表成功。

错误码

请参见错误码。