Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Restarting an Instance or a Node
Updated on 2025-02-28 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

URI

POST https://{Endpoint}/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

Explanation:

User token

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

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

node_id

No

String

Explanation:

ID of a node to be restarted

Constraints:

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

Values:

Node ID

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

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

Task ID.

Values:

N/A

Example Request

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/restart
  • Example request body 
    { }

Example Response

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