Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Stopping a DB Instance or Node
Updated on 2025-08-11 GMT+08:00
View PDF
Share

Stopping a DB Instance or Node

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/db-stop

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

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 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.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

node_ids

Yes

Array of strings

Definition

IDs of the nodes to be stopped.

Constraints

The value cannot be null. If this parameter is left blank, the instance is stopped.

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Definition

ID of the asynchronous task for stopping a DB instance or node.

Range

N/A

Example Request

Stopping a DB instance and enabling Transparent Data Encryption

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/db-stop
{  
  "node_ids":  ["187ff420e15c467eaaef226154eb1578no14","4ed9cbb0d61144e0802a82c0ab0e1de5no14"]
}

Example Response

Instance stopped.

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management