升级ES集群版本

最近更新时间:2020-11-18 08:18:33

1. 接口描述

接口请求域名: es.tencentcloudapi.com 。

升级ES集群版本

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:es.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeInstance。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
EsVersion String 目标ES版本,支持:”6.4.3“, "6.8.2","7.5.1"
CheckOnly Boolean 是否只做升级检查,默认值为false
LicenseType String 目标商业特性版本:
  • oss 开源版
  • basic 基础版
  • 当前仅在5.6.4升级6.x版本时使用,默认值为basic
    BasicSecurityType Integer 6.8(及以上版本)基础版是否开启xpack security认证
  • 1:不开启
  • 2:开启
  • UpgradeMode String 升级方式:
  • scale 蓝绿变更
  • restart 滚动重启
  • 默认值为scale

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 升级ES集群版本

    输入示例

    https://es.tencentcloudapi.com/?Action=UpgradeInstance
    &InstanceId=es-xxxxxxxx
    &EsVersion=6.4.3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.ErrorClusterState 集群状态错误。
    FailedOperation.NoPayment 账户未绑定信用卡或paypal,无法支付。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    ResourceInUse 资源被占用。
    ResourceInsufficient 资源不足。
    ResourceInsufficient.Balance 账户余额不足。
    ResourceInsufficient.Subnet 子网剩余ip数量不足。
    UnsupportedOperation 操作不支持。
    目录