You can call this operation to query the nodes where the data can be migrated based on the specified type and number of 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 header

This operation only uses the common request header. For more information, see the Common request parameters topic.

Request syntax

GET /openapi/instances/[InstanceId]/transferable-nodes HTTP/1.1

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-xxx

The ID of the instance.

count Integer Yes 1

The number of nodes from which you want to migrate data.

nodeType String Yes WORKER

The type of nodes. Valid values: WORKER (hot nodes) and WORKER_WARM (warm nodes).

Response parameters

Parameter Type Example Description
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.

Result Array

The type of the nodes. Valid values:

  • MASTER: dedicated master node
  • WORKER: hot node
  • WORKER_WARM: warm node
  • COORDINATING: client node
  • KIBANA: Kibana node
host String 192.168.**. **

The IP address of the node.

port Integer 9300

The port of the node.

Examples

Sample requests

GET /openapi/instances/[InstanceId]/transferable-nodes HTTP/1.1
Common request header
{
  "count": 1
  "InstanceId": "es-cn-xxx"
  "nodeType": "WORKER"
}

Sample success responses

XML format

<Result>
    <nodeType>WORKER</nodeType>
    <host>192.168. **.**</host>
    <port>9300</port>
    <zoneId>cn-hangzhou-b</zoneId>
</Result>
<RequestId>3760F67B-691D-4663-B4E5-6783554F****</RequestId>

JSON format

{
	"Result":[
		{
			"port":9300,
			"host":"192.168. **.**",
			"nodeType":"WORKER",
			"zoneId":"cn-hangzhou-b"
		}
	],
	"RequestId":"3760F67B-691D-4663-B4E5-6783554F****"
}

Sample response description

The sample responses may contain parameters that are not described in the preceding table. These parameters are only for reference. You must make sure that your application is not strongly reliant on these parameters.

Error codes

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