Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Stopping a DB Instance or Node
Updated on 2024-11-07 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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-stop

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, 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

String

ID of the instance to be stopped.

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

Values:

  • 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 stopped. The value cannot be null. If the list is empty, the instance is stopped.

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

ID of the asynchronous task for stopping a DB instance or node.
Table 5 Parameter description

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

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