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

错误码

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