Files

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>

2025-09-04 07:22:35 +00:00

13 KiB

Raw Blame History

Deleting Nodes from a Specified Instance

Function

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

Constraints

This API supports GeminiDB Cassandra instances.

URI

POST https://{Endpoint}/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
Content-Type	Yes	String	MIME type of the request body. application/json is recommended.
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. For GeminiDB Cassandra instances, the value ranges from 1 to 10. 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 based on the internal policy of the system. NOTE: Either num or node_list must be set. If node_list is transferred, its value can contain 1 to 10 characters for GeminiDB Cassandra. 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 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.

Example Request

URI example

POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node

Deleting a node

{
   "num" : 1,
   "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ]
}

Example Response

Status code: 202

Accepted

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Instances

13 KiB Raw Blame History