文档首页/ 分布式消息服务RocketMQ版/ API参考/ API V2(推荐)/ 实例管理/ 恢复回收站实例 - RestoreRecycleInstance
更新时间:2026-01-23 GMT+08:00

恢复回收站实例 - RestoreRecycleInstance

功能介绍

恢复回收站实例。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dms:instance:restore

    Write

    kafka

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dms:instance:modify

    -

    rabbitmq

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    rocketmq

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

URI

POST /v2/{project_id}/recycle

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instances

Array of strings

参数解释

实例列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

results

Array of InstanceResumeResult objects

参数解释

实例列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 InstanceResumeResult

参数

参数类型

描述

instance_id

String

参数解释

实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

job_id

String

参数解释

任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

恢复回收站实例成功。

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

{
  "instances" : [ "9b6b7173-d1d8-4604-86a8-43b732715a03" ]
}

响应示例

状态码:200

恢复回收站实例成功。

{
  "results" : [ {
    "instance_id" : "9b6b7173-d1d8-4604-86a8-43b732715a03,",
    "job_id" : "8abfa7b39a91da03019a960bed49560e,",
    "error_msg" : null
  } ]
}

状态码

状态码

描述

200

恢复回收站实例成功。

错误码

请参见错误码