Updated on 2026-09-24 GMT+08:00

Stopping a DB Instance or Node

Function

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

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

Constraints

A stopped instance will not be moved to the recycle bin after being deleted.
Stopping an instance will also stop its automated backups. After an instance is started, a full backup is automatically triggered.
A stopped instance may fail to start due to insufficient underlying resources. If the instance fails to be started, try again later, or use its latest backup file to restore its data to a new instance. Alternatively, contact customer service.

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. For details about how to obtain the instance ID, see Querying DB Instances. 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 a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language of the information returned by the API. Constraints N/A Range zh-cn: Chinese en-us: English 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. To obtain the value, see Querying the Components of a DB Instance. 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 an instance

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 Codes

Normal
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management