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

调用该接口时请注意：

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

调试

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

请求头

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

请求语法

POST /openapi/instances/[InstanceId]/actions/shrink HTTPS|HTTP

请求参数

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

实例ID。
nodeType String 是 WORKER

需要缩容的节点类型。WORKER表示热节点，WORKER_WARM表示冷节点。

clientToken String 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

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

是否忽略集群健康状态，默认为false。

RequestBody

RequestBody中还需填入以下参数，用来指定待缩容节点的IP地址和端口号。

名称

类型

是否必选

示例值

描述

host

String

是

192.168.xx.xx

节点的IP地址。

port

Integer

是

9200

节点的访问端口号。

示例如下。


[
	{
		"host": "192.168.**.**",
		"port": 9200
	},
	{
		"host": "192.168.**.**",
		"port": 9200
	}
]

返回数据

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

请求ID。
Result Boolean true

返回结果：

  • true：缩容成功
  • false：缩容失败

示例

请求示例

POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/shrink?nodeType=WORKER HTTP/1.1
公共请求头
[
	{
		"host": "192.168.**.**",
		"port": 9200
	},
	{
		"host": "192.168.**.**",
		"port": 9200
	}
]

正常返回示例

XML 格式 

<Result>true</Result>
<RequestId>C82758DD-282F-4D48-934F-92170A33****</RequestId>

JSON 格式 

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

错误码

HttpCode 错误码 错误信息 描述
400 InstanceNotFound The instanceId provided does not exist. 实例找不到，请核对实例状态。

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