Checks whether specific nodes can be removed from a specified Elasticsearch cluster.


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}/validate-shrink-nodes 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
ignoreStatus Boolean Query No false

Whether to ignore the cluster health status:

  • true: Ignore
  • false (default): Do 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


  • true: can be scaled in
  • false: cannot scale in
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.


Sample requests

POST /openapi/instances/es-cn-nif1q9o8r0008****/validate-shrink-nodes?nodeType=WORKER&ignoreStatus=false HTTP/1.1

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

Sample success responses

JSON format

HTTP/1.1 200 OK

  "Result" : true,
  "RequestId" : "3760F67B-691D-4663-B4E5-6783554F****"

Error codes

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