Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Instances> Restarting an Instance
Updated on 2023-11-21 GMT+08:00
View PDF

Restarting an Instance

Function

This API is used to restart an instance.

Constraints

  • This API supports the following types of instances:
    • GeminiDB Cassandra
    • GeminiDB Mongo
    • GeminiDB Influx
    • GeminiDB Redis
  • If the instance status is not normal, the instance cannot be restarted.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Requests

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

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