更新ES集群实例

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

1. 接口描述

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

对集群进行节点规格变更,修改实例名称,修改配置,重置密码, 添加Kibana黑白名单等操作。参数中InstanceId为必传参数,ForceRestart为选填参数,剩余参数传递组合及含义如下:

  • InstanceName:修改实例名称(仅用于标识实例)
  • NodeInfoList: 修改节点配置(节点横向扩缩容,纵向扩缩容,增加主节点,增加冷节点等)
  • EsConfig:修改集群配置
  • Password:修改默认用户elastic的密码
  • EsAcl:修改访问控制列表
  • CosBackUp: 设置集群COS自动备份信息 以上参数组合只能传递一种,多传或少传均会导致请求失败

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateInstance。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
InstanceName String 实例名称(1-50 个英文、汉字、数字、连接线-或下划线_)
NodeNum Integer 已废弃请使用NodeInfoList
节点个数(2-50个)
EsConfig String 配置项(JSON格式字符串)
Password String 默认用户elastic的密码(8到16位,至少包括两项([a-z,A-Z],[0-9]和[-!@#$%&^*+=_:;,.?]的特殊符号)
EsAcl EsAcl 访问控制列表
DiskSize Integer 已废弃请使用NodeInfoList
磁盘大小(单位GB)
NodeType String 已废弃请使用NodeInfoList
节点规格
  • ES.S1.SMALL2:1核2G
  • ES.S1.MEDIUM4:2核4G
  • ES.S1.MEDIUM8:2核8G
  • ES.S1.LARGE16:4核16G
  • ES.S1.2XLARGE32:8核32G
  • ES.S1.4XLARGE32:16核32G
  • ES.S1.4XLARGE64:16核64G
  • MasterNodeNum Integer 已废弃请使用NodeInfoList
    专用主节点个数(只支持3个或5个)
    MasterNodeType String 已废弃请使用NodeInfoList
    专用主节点规格
  • ES.S1.SMALL2:1核2G
  • ES.S1.MEDIUM4:2核4G
  • ES.S1.MEDIUM8:2核8G
  • ES.S1.LARGE16:4核16G
  • ES.S1.2XLARGE32:8核32G
  • ES.S1.4XLARGE32:16核32G
  • ES.S1.4XLARGE64:16核64G
  • MasterNodeDiskSize Integer 已废弃请使用NodeInfoList
    专用主节点磁盘大小(单位GB系统默认配置为50GB,暂不支持自定义)
    ForceRestart Boolean 更新配置时是否强制重启
  • true强制重启
  • false不强制重启
  • 当前仅更新EsConfig时需要设置,默认值为false
    CosBackup CosBackup COS自动备份信息
    NodeInfoList.N Array of NodeInfo 节点信息列表,可以只传递要更新的节点及其对应的规格信息。支持的操作包括
  • 修改一种节点的个数
  • 修改一种节点的节点规格及磁盘大小
  • 增加一种节点类型(需要同时指定该节点的类型,个数,规格,磁盘等信息)
  • 上述操作一次只能进行一种,且磁盘类型不支持修改
    PublicAccess String 公网访问状态
    EsPublicAcl EsPublicAcl 公网访问控制列表
    KibanaPublicAccess String Kibana公网访问状态
    KibanaPrivateAccess String Kibana内网访问状态
    BasicSecurityType Integer ES 6.8及以上版本基础版开启或关闭用户认证
    KibanaPrivatePort Integer Kibana内网端口
    ScaleType Integer 0: 蓝绿变更方式扩容,集群不重启 (默认) 1: 磁盘解挂载扩容,集群滚动重启
    MultiZoneInfo.N Array of ZoneDetail 多可用区部署
    SceneType Integer 场景化模板类型 -1:不启用 1:通用 2:日志 3:搜索

    3. 输出参数

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

    4. 示例

    示例1 修改ES集群实例名称

    用以修改指定ES集群实例的名称

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxx
    &InstanceName=newName
    &<公共请求参数>

    输出示例

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

    示例2 ES集群节点规格变更

    用以对指定ES集群实例进行横向扩缩容,纵向扩缩容,增加专用主节点,专用主节点横向扩缩容,纵向扩缩容等操作,NodeInfoList要传递目标的全量节点信息

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxx
    &NodeInfoList.0.Type=hotData
    &NodeInfoList.0.NodeNum=2
    &NodeInfoList.0.NodeType=ES.S1.SMALL2
    &NodeInfoList.0.DiskType=CLOUD_SSD
    &NodeInfoList.0.DiskSize=100
    &NodeInfoList.1.Type=dedicatedMaster
    &NodeInfoList.1.NodeNum=3
    &NodeInfoList.1.NodeType=ES.S1.SMALL2
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6001962a-17c5-4604-a0af-0d4719xxxxxx"
      }
    }

    示例3 修改ES集群实例配置

    用以对指定的ES集群实例的配置进行修改操作

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxxxx
    &EsConfig={"action.destructive_requires_name":"true"}
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "e7c1bb22-e5f2-42f1-8a12-a97a6dxxxxxx"
      }
    }

    示例4 重置Kibana密码

    重置指定ES集群实例Kibana密码

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxxxx
    &Password=newPwd_123
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "1b72089e-720f-4f95-a4ae-4da461xxxxxx"
      }
    }

    示例5 ES集群纵向扩缩容

    用以对集群的节点规格(核数、内存大小)和磁盘大小进行扩缩容操作(当前仅支持纵向扩容)

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxxxx
    &NodeType=ES.S1.MEDIUM4
    &DiskSize=150
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx"
      }
    }

    示例6 ES设置COS自动备份

    输入示例

    https://es.tencentcloudapi.com/?Action=UpdateInstance
    &InstanceId=es-xxxxxxxx
    &CosBackup.IsAutoBackup=true
    &CosBackup.BackupTime=23:00
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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