調用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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。