Updated on 2025-07-29 GMT+08:00

Rebooting a StarRocks Node

Function

This API is used to reboot a StarRocks node. Before calling this API:

URI

PUT /v3/{project_id}/instances/{starrocks_instance_id}/starrocks/{starrocks_node_id}/restart

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

starrocks_node_id

Yes

String

Definition

ID of a StarRocks instance node, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of no17. Only letters and digits are allowed.

Default Value

N/A

starrocks_instance_id

Yes

String

Definition

StarRocks instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

workflow_id

String

Definition

Workflow ID.

Range

N/A

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Rebooting a node of a StarRocks instance

PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/9ac58f9b88744f8a87893d22f6ef9a28in17/starrocks/2c464fbdc8ea4c59814dab2243d8e270no17/restart

Example Response

Status code: 200

Success.

{
  "workflow_id" : "e1bfd0d1-b8d8-417c-9947-7e2ae0de9745"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.