Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Deleting Nodes from an Instance
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Deleting Nodes from an Instance

Function

This API is used to delete nodes from a specified instance.

Constraints

This API supports the following instances:

  • Yearly/Monthly and pay-per-use GeminiDB Cassandra instances
  • Yearly/Monthly and pay-per-use GeminiDB Redis instances
  • Yearly/Monthly and pay-per-use GeminiDB Influx instances
  • You can change the billing mode of a GeminiDB Mongo instance from yearly/monthly to pay-per-use.

The maximum and minimum storage space of each GeminiDB Redis instance depends on its node quantity and specifications. If the new storage space cannot meet the requirements for running the instance, nodes cannot be removed.

GeminiDB Mongo allows you to delete only read-only nodes from instances.

This API can be used to delete nodes from two GeminiDB Redis instances between which there is a dual-active DR relationship.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:deleteNode

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId
    • nosql:instance:delete
    • nosql:instance:reduceNode

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

num

No

Integer

Definition

Number of nodes to be deleted randomly.

NOTE:

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

Constraints

Value type

Range

  • For GeminiDB Cassandra instances, the value ranges from 1 to 10.
  • For GeminiDB Redis instances, the value is 1–10.

Default Value

N/A

node_list

No

Array of strings

Definition

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 based on the internal policy of the system.

Constraints

  • Either num or node_list must be set.
    • If node_list is transferred, its value can contain 1 to 10 characters for GeminiDB Cassandra instances and 1 to 10 characters for GeminiDB Redis instances.
    • 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.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

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

Range

N/A

order_id

String

Definition

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

Range

N/A

Example Requests

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

Example Responses

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

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances