Help Center> GaussDB> API Reference> APIs (Recommended)> Database and Account Management> Starting a Database
Updated on 2024-07-12 GMT+08:00
View PDF

Starting a Database

Function

This API is used to start a database or node. Before calling this API:

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-startup

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

node_ids

Yes

Array of strings

ID of the node to be started. The value cannot be null. If the value is empty, the instance is started.

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

ID of the asynchronous task for starting the database.

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/db-startup
{
 "node_ids":  [ "a4e6ca5a624745bcb546a227aa373kcfin14","b6e6ca5a624745bcb546a229si3ae1cfin14"]
}

Example Response

{ 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
 }

Status Code

Error Code

For details, see Error Codes.