Starting a DB Instance or Node_Instance Management_APIs (Recommended)_API Reference

Function

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

Learn how to authenticate this API.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the value, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Language. Default value: en-us Value range: zh-cn en-us

**Table 3** 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 left blank, the instance is started.

Response Parameters

**Table 4** Parameter description
Parameter	Type	Description
job_id	String	ID of the asynchronous task for starting a DB instance or node.

**Table 5** Parameter description
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Starting a node

POST https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/cc94568cb5a54e4a8ab5dff95e64a5e0br14/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/db-startup
{
  "node_ids":  ["187ff420e15c467eaaef226154eb1578no14","4ed9cbb0d61144e0802a82c0ab0e1de5no14"]
}

Example Response

Node started.

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

Status Code

Normal
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Starting a DB Instance or Node