Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Starting or Stopping a Node
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Starting or Stopping a Node

Function

This API is used to stop a node and enable other nodes to take over services after a node cannot work properly due to an underlying fault.

Constraints

This API supports the following instance:

  • GeminiDB Redis

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:switchNodeStatus

    Write

    -

    -

    nosql:instance:switchNodeStatus

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/nodes

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

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Operation type

Constraints

N/A

Range

shutdown

startup

Default Value

N/A

node_ids

Yes

Array of strings

Definition

Node ID list

Constraints

A maximum of 10 IDs are supported.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID

Range

N/A

Example Requests

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/nodes 
 
{ 
  "action" : "shutdown", 
  "node_ids" : [ "d96eaf85e4b44b2aa800dcf2a5981711no12", "e76f07fb1dae420791af867fc2ac4c35no12" ] 
}

Example Responses

Status code: 202

Successful response

{ 
  "job_id" : "e20eae83-1e77-4d58-8d92-c195e6372b0b" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances