Removes nodes from an Elasticsearch cluster.

Note when you call this operation:

Before you remove data nodes, you must migrate the data stored on them to other nodes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

POST /openapi/instances/{InstanceId}/actions/shrink HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
InstanceId String Path Yes es-cn-nif1q9o8r0008****

The ID of the instance.

nodeType String Query Yes WORKER

The type of the node to be scaled in. Valid values:

  • WORKER: hot node
  • WORKER_WARM: warm node
clientToken String Query No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ignoreStatus Boolean Query No false

Whether to ignore the cluster health status:

  • true: Ignore
  • false: does not ignore
Array Body No

The body of the HTTP request.

host String Body No 192.168.xx.xx

The IP address of the node.

port Integer Body No 9200

The access port number of the node.

zoneId String Body No cn-shanghai-c

The ID of the zone where the instance node resides. For example, Shanghai Zone C is cn-shanghai-c.

Response parameters

Parameter Type Example Description
Result Boolean true

Output:

  • true: The scale-in is successful.
  • false: The scale-out fails.
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.

Examples

Sample requests

POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/shrink?nodeType=WORKER&clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&ignoreStatus=false HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

[ {
  "host" : "192.168.xx.xx",
  "port" : 9200,
  "zoneId" : "cn-shanghai-c"
} ]

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "C82758DD-282F-4D48-934F-92170A33****"
}

Error codes

For a list of error codes, visit the API Error Center.