Updated on 2026-10-29 GMT+08:00

Restarting Brokers

Function

This API is used to restart brokers.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
engine	Yes	String	Definition Message engine type. Constraints N/A Range rocketmq: RocketMQ message engine. reliability: RocketMQ message engine alias. Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
nodes	Yes	Array of strings	Definition IDs of brokers. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instance_id	String	Definition Instance ID. Range N/A
nodes	Array of strings	Definition IDs of brokers. Range N/A
result	String	Definition Result. Range N/A

Example Requests

Restart brokers.

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

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

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Successful.

Error Codes

See Error Codes.

Parent Topic: Instance Management