Deleting Nodes from a Specified Instance¶

Function¶

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

This API supports GaussDB(for Cassandra) instances.

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reduce-node

**Table 1** Path 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

**Table 2** Request header parameters¶
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. For GaussDB(for Cassandra) instances, the value ranges 1 to 10. Note If users connect to nodes using the client, do no choose to delete node randomly.
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 GaussDB(for 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 whose ID is specified is deleted. Before a node is deleted, do not connect to the node directly to avoid service interruptions.

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.

URI example

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

Deleting a node

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

Status code: 202

Accepted

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

For details, see Status Codes.

For details, see Error Codes.

last updated: 2024-07-25 00:37