文档首页/ 分布式消息服务RocketMQ版/ API参考/ API V2（推荐）/ 实例管理/ 重启节点 - RestartInstance
更新时间：2026-07-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

重启节点 - RestartInstance

功能介绍

重启节点。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/{engine}/instances/{instance_id}/restart

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

engine

是

String

参数解释：

消息引擎类型。

约束限制：

不涉及。

取值范围：

  • rocketmq：RocketMQ引擎。

  • reliability：RocketMQ引擎别称。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

nodes

是

Array of strings

参数解释：

Broker节点ID列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

nodes

Array of strings

参数解释：

Broker节点ID列表。

取值范围：

不涉及。

result

String

参数解释：

结果。

取值范围：

不涉及。

请求示例

重启Broker节点。

POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/restart

{
  "nodes" : [ "8abfa7b29e4c2c7e019e4d4100aa230f", "8abfa7b29e4c2c7e019e4d40fda6230e", "8abfa7b29e4c2c7e019e4d4103862310" ]
}

响应示例

状态码：200

操作成功。

{
  "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
  "nodes" : [ {
    "name" : "8abfa7b29e4c2c7e019e4d4100aa230f"
  }, {
    "name" : "8abfa7b29e4c2c7e019e4d40fda6230e"
  }, {
    "name" : "8abfa7b29e4c2c7e019e4d4103862310"
  } ],
  "result" : "success"
}

状态码

状态码

描述

200

操作成功。

错误码

请参见错误码。

父主题： 实例管理

相关文档