调用ShrinkNode，执行集群节点缩容操作。

调用该接口时请注意：

在进行集群数据节点缩容前，需要先将待缩容节点中的数据迁移到其他节点，保证待缩容节点中无数据后，再进行集群节点缩容操作。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path 是 es-cn-nif1q9o8r0008****

实例ID。
nodeType String Query 是 WORKER

需要缩容的节点类型，可选值：

  • WORKER：热节点
  • WORKER_WARM：冷节点
clientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。
ignoreStatus Boolean Query 否 false

是否忽略集群健康状态：

  • true：忽略
  • false：不忽略
count Integer Query 否 2

缩节点数量。

重要 此参数仅适用于ACK架构实例，且不支持填写body中的host参数。
Array Body 否

请求体。
host String Body 否 192.168.xx.xx

节点的IP地址。
zoneId String Body 否 cn-shanghai-c

实例节点所在的可用区ID。例如，上海可用区C为cn-shanghai-c。
nodeType String Body 否 WORKER

需要缩容的节点类型，可选值：

  • WORKER：热节点
  • WORKER_WARM：冷节点
port Integer Body 否 9200

节点的访问端口号。
hostName String Body 否 es-cn-pl32xxxxxxx-data-f-1

云原生ACK架构集群的节点名称，可调用ListAllNode接口获取。

返回数据

名称 类型 示例值 描述
Result Boolean true

返回结果：

  • true：缩容成功
  • false：缩容失败
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

请求ID。

示例

请求示例

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"
} ]

正常返回示例

JSON格式

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

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

错误码

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