Checks whether the data on specific nodes in a specified Elasticsearch cluster can be migrated.


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-transfer-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 nodes. Valid values:

  • WORKER: hot node
  • WORKER_WARM: warm node
Note The COORDINATING and KIBANA nodes are not supported.
Array Body No

The body of the request.

host String Body No 172.16.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

Returned results:

  • true: can be migrated
  • false: cannot be migrated.
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.


Sample requests

POST /openapi/instances/es-cn-nif1q9o8r0008****/validate-transfer-nodes?nodeType=WORKER HTTP/1.1

[ {
  "host" : "172.16.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, see Service error codes.