Updated on 2025-08-13 GMT+08:00

Restarting an Instance

Function

This API is used to restart an instance.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

engine

Yes

String

Engine type.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Type

Description

nodes

Array of strings

Node list.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID.

nodes

Array of strings

Node list.

result

String

Result.

Example Requests

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

Example Responses

Status code: 200

Successful

{
  "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
  "nodes" : [ {
    "name" : "broker-0"
  }, {
    "name" : "broker-1"
  }, {
    "name" : "broker-2"
  } ],
  "result" : "success"
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.