Help Center/ GeminiDB/ API Reference/ APIs v3/ Instances/ Deleting Instance Nodes
Updated on 2025-09-23 GMT+08:00
View PDF

Deleting Instance Nodes

Function

This API is used to delete instance nodes.

Constraints

This API supports the following instance types:

  • Yearly/Monthly and pay-per-use GeminiDB Cassandra instances
  • Yearly/Monthly and pay-per-use GeminiDB Redis instances

URI

POST /v3/{project_id}/instances/{instance_id}/reduce-node

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

num

No

Integer

Number of nodes to be deleted randomly.

NOTE:

If the client is directly connected to a node, random scale-in is not recommended.

node_list

No

Array of strings

ID of the node to be deleted. Make sure that the node can be deleted. If this parameter is not transferred, the number of nodes to be deleted is specified based on the internal system policy.

NOTE:
  • Either num or node_list must be set.
    • If num and node_list are both transferred, the value of node_list takes effect.
  • If node_list is empty, instance nodes are deleted randomly. If node_list is not empty, only the node with a specified ID is deleted.
  • Before a node is deleted, do not connect to the node directly to avoid service interruptions.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID. This parameter is returned only for pay-per-use instances.

order_id

String

Order ID. This parameter is returned only for yearly/monthly instances.

Example Request

  • URI example 
    POST https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node
  • Deleting a node 
    {
   "num" : 1,
   "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ]
}

Example Response

Status code: 202

Accepted

Example response for a pay-per-use instance:

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Instances