Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Rebooting a Node
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Rebooting a Node

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/restart

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

node_id

Yes

String

Node ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

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

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

delay

No

Boolean

Whether the node is rebooted immediately or in the specified maintenance window.

  • true: The node is rebooted in the specified maintenance window.
  • false (default value): The node is rebooted immediately. It is a default value.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Rebooting a node of a DB instance 
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/af315b8e6aaa41799bd9a31f2de15abcin07/nodes/f0d5f01f04964f36a545ad85e4e9cfe9no07/restart
{
  "delay": false
}

Example Response

Success.

{
  "job_id" : "6b7dd5d4-4590-4f14-b164-a8737ce071d5"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management