調用UpgradeEngineVersion,升級Elasticsearch的實例版本或內核補丁版本。

說明 升級實例版本功能目前只支持5.5.3版本升級到5.6.16版本、5.6.16版本升級到6.3.2版本、6.3.2版本升級到6.7.0版本,暫不支持其他版本間的升級。詳情請參見升級版本

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /openapi/instances/{InstanceId}/actions/upgrade-version HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path es-cn-n6w1o1x0w001c****

實例ID。

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

用于保證請求的冪等性。由客戶端生成該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字符。

dryRun Boolean Query false

是否進行升級前校驗:

  • true:校驗
  • false(默認):不校驗
警告 版本升級校驗涉及集群YML、插件配置、集群狀態、索引、資源等檢查,強烈建議升級前進行前置校驗,否則可能帶來升級問題。
Object Body

請求體。

version String Body 6.7

升級后的版本。當type為engineVersion時,取值為實例版本,例如6.7;當type為aliVersion時,取值為內核版本,例如ali1.2.0。

type String Body engineVersion

升級類型,可選值:

  • engineVersion(默認):大版本升級
  • aliVersion:內核版本升級

返回數據

名稱 類型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DC*****

請求ID。

Result Array of Result

返回結果。

validateType String checkClusterHealth

校驗類型。支持:

  • checkClusterHealth:集群健康狀態
  • checkConfigCompatible:配置兼容狀態
  • checkClusterResource:資源空間狀態
  • checkClusterSnapshot:是否存在快照
validateResult Array of validateResult

校驗信息。

errorType String clusterStatus

錯誤類型。支持:

  • clusterStatus:集群健康狀態
  • clusterConfigYml:集群YML文件
  • clusterConfigPlugins:集群配置文件
  • clusterResource:集群資源
  • clusterSnapshot:集群快照
errorCode String ClusterStatusNotHealth

錯誤碼。

errorMsg String The cluster status is not health

錯誤信息。

status String success

校驗是否通過。支持:

  • success:通過
  • failed:未通過

示例

請求示例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/upgrade-version?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&dryRun=false HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "version" : "6.7",
  "type" : "engineVersion"
}

正常返回示例

JSON格式

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

{
  "Result" : [ {
    "validateType" : "checkClusterHealth",
    "status" : "failed",
    "validateResult" : [ {
      "errorType" : "clusterStatus",
      "errorCode" : "ClusterStatusNotHealth",
      "errorMsg" : "ClusterStatusNotHealth"
    } ]
  }, {
    "validateType" : "checkConfigCompatible",
    "status" : "failed",
    "validateResult" : [ {
      "errorType" : "clusterConfigYml",
      "errorCode" : "ClusterYamlNotCompatible",
      "errorMsg" : "ClusterYamlNotCompatible"
    }, {
      "errorType" : "clusterConfigPlugins",
      "errorCode" : "ClusterPluginsNotSupport",
      "errorMsg" : "ClusterPluginsNotSupport"
    } ]
  }, {
    "validateType" : "checkClusterResource",
    "status" : "failed",
    "validateResult" : [ {
      "errorType" : "clusterResource",
      "errorCode" : "ClusterResourceNotEnough",
      "errorMsg" : "ClusterResourceNotEnough"
    } ]
  }, {
    "validateType" : "checkClusterSnapshot",
    "status" : "failed",
    "validateResult" : [ {
      "errorType" : "clusterSnapshot",
      "errorCode" : "ClusterSnapshotNotAvaild",
      "errorMsg" : "ClusterSnapshotNotAvaild"
    } ]
  } ],
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DC****"
}

錯誤碼

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