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

Restarting an Instance or a Node

Function

This API is used to restart an instance or a node.

Constraints

  • Instances of the following types can be restarted:
    • GeminiDB Cassandra
    • GeminiDB Mongo
    • GeminiDB Influx
    • GeminiDB Redis
  • If the instance status is not normal, the instance cannot be restarted.
  • Nodes of instances of the following types can be restarted:
    • GeminiDB Redis instances with cloud native storage

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:restart

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:restart

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

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

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default value:

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

node_id

No

String

Definition

ID of a node to be restarted

Constraints

Only GeminiDB Redis instances with cloud native storage can be restarted based on the node ID.

Range

Node ID

If this parameter is not specified, the entire instance is restarted.

Default value:

N/A

is_delayed

No

Boolean

Definition

Whether an instance can be restarted during the maintenance window

Constraints

N/A

Range

  • true: The restart is delayed.
  • false: The instance is restarted immediately.

Default Value

false

is_parallel

No

Boolean

Definition

Whether instances are restarted all at once

Constraints

This parameter is not supported by GeminiDB Cassandra API.

Range

  • true: Instances are restarted all at once.
  • false: Instances are restarted one by one.

Default Value

false

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Example Requests

  • Restart instance 944bdc55da6c4b33b260b34185ac86bein13 immediately. 
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/restart
  • Restart instance 534bsc43da6c3356b260g44185ac86bein12 later. 
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/534bsc43da6c3356b260g44185ac86bein12/restart
  • Example request body 
    { 
   "is_delayed" : true 
 }

Example Responses

Status code: 202

Accepted

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances