调用GetTransferableNodes,指定节点类型和个数,获取数据可迁移的节点。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/instances/[InstanceId]/transferable-nodes HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
count Integer 1

期望获取数据可迁移节点的数量。

InstanceId String es-cn-xxx

实例ID。

nodeType String WORKER

需要进行数据迁移的节点类型:WORKER表示热节点,WORKER_WARM表示冷节点。

返回数据

名称 类型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

当前请求的Request ID。

Result Array

节点类型,可选值:

  • MASTER:专有主节点
  • WORKER:热节点
  • WORKER_WARM:冷节点
  • COORDINATING:协调节点
  • KIBANA:Kibana节点
host String 192.168.**.**

主机IP。

port Integer 9300

主机端口。

示例

请求示例

GET /openapi/instances/[InstanceId]/transferable-nodes HTTP/1.1
公共请求头
{
  "count": 1
  "InstanceId": "es-cn-xxx"
  "nodeType": "WORKER"
}

正常返回示例

XML 格式

<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 格式

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

返回示例补充说明

以上返回的参数信息中,本文只保证包含返回参数列表中提到的参数信息,而未提到的参数信息仅供参考,程序中不能强制依赖获取这些参数。

错误码

访问错误中心查看更多错误码。