更新ES集群实例

1. 接口描述

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

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

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

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 重置Kibana密码

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

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<公共请求参数>

{
    "InstanceId": "es-xxxxxxxx",
    "Password": "newPwd_123"
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

示例2 ES集群纵向扩缩容

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

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<公共请求参数>

{
    "InstanceId": "es-xxxxxxxx",
    "DiskSize": "150",
    "NodeType": "ES.S1.MEDIUM4"
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

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

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

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<公共请求参数>

{
    "InstanceId": "es-xxxxxx",
    "NodeInfoList": [
        {
            "NodeType": "ES.S1.SMALL2",
            "NodeNum": "3",
            "Type": "dedicatedMaster"
        },
        {
            "DiskSize": "100",
            "NodeType": "ES.S1.SMALL2",
            "NodeNum": "2",
            "Type": "hotData",
            "DiskType": "CLOUD_SSD"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

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

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

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<公共请求参数>

{
    "InstanceId": "es-xxxxxx",
    "InstanceName": "newName"
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

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

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

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateInstance
<公共请求参数>

{
    "InstanceId": "es-xxxxxxxx",
    "EsConfig": "{\"action.destructive_requires_name\":\"true\"}"
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "DealName": "1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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