帮你快速理解、总结文档立即下载

更新ES集群实例的公网开关

最近更新时间:2026-07-31 02:00:14

我的收藏

1. 接口描述

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

更新ES集群实例的Kibana、cerebro公网开关

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateInstancePublicAccess。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:es-xxxxxx
InstanceName String 实例名称(1-50 个英文、汉字、数字、连接线-或下划线_)
示例值:newName
NodeNum Integer 已废弃请使用NodeInfoList
节点个数(2-50个)
示例值:3
EsConfig String ES配置项(JSON格式字符串)
Password String 默认用户elastic的密码(8到16位,至少包括两项([a-z,A-Z],[0-9]和[-!@#$%&^*+=_:;,.?]的特殊符号)
EsAcl EsAcl 访问控制列表
DiskSize Integer 已废弃请使用NodeInfoList
磁盘大小(单位GB)
示例值:已废弃请使用NodeInfoList
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

  • 示例值:已废弃请使用NodeInfoList
    MasterNodeNum Integer 已废弃请使用NodeInfoList
    专用主节点个数(只支持3个或5个)
    示例值:已废弃请使用NodeInfoList
    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

  • 示例值:已废弃请使用NodeInfoList
    MasterNodeDiskSize Integer 已废弃请使用NodeInfoList
    专用主节点磁盘大小(单位GB系统默认配置为50GB,暂不支持自定义)
    示例值:已废弃请使用NodeInfoList
    ForceRestart Boolean 更新配置时是否强制重启
  • true强制重启
  • false不强制重启
  • 当前仅更新EsConfig时需要设置,默认值为false
    示例值:已废弃请使用NodeInfoList
    CosBackup CosBackup COS自动备份信息
    NodeInfoList.N Array of NodeInfo 节点信息列表,可以只传递要更新的节点及其对应的规格信息。支持的操作包括
  • 修改一种节点的个数
  • 修改一种节点的节点规格及磁盘大小
  • 增加一种节点类型(需要同时指定该节点的类型,个数,规格,磁盘等信息)
  • 上述操作一次只能进行一种,且磁盘类型不支持修改
    PublicAccess String 公网访问状态
    示例值:OPEN
    EsPublicAcl EsPublicAcl 公网访问控制列表
    KibanaPublicAccess String Kibana公网访问状态
    示例值:OPEN
    KibanaPrivateAccess String Kibana内网访问状态
    示例值:OPEN
    BasicSecurityType Integer ES 6.8及以上版本基础版开启或关闭用户认证
    示例值:1
    KibanaPrivatePort Integer Kibana内网端口
    示例值:5601
    ScaleType Integer 0: 蓝绿变更方式扩容,集群不重启 (默认) 1: 磁盘解挂载扩容,集群滚动重启
    示例值:0
    MultiZoneInfo.N Array of ZoneDetail 多可用区部署
    SceneType Integer 场景化模板类型 -1:不启用 1:通用 2:日志 3:搜索
    示例值:-1
    KibanaConfig String Kibana配置项(JSON格式字符串)
    WebNodeTypeInfo WebNodeTypeInfo 可视化节点配置
    SwitchPrivateLink String 切换到新网络架构
    EnableCerebro Boolean 启用Cerebro
    CerebroPublicAccess String Cerebro公网访问状态
    CerebroPrivateAccess String Cerebro内网访问状态
    EsConfigSet EsConfigSetInfo 新增或修改的配置组信息
    OperationDuration OperationDurationUpdated 可维护时间段
    KibanaAlteringPublicAccess.N Array of String 是否开启Altering 外网告警输出
    示例值:OPEN

    3. 输出参数

    参数名称 类型 描述
    DealName String 订单号
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:123
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 ES集群开启kibana公网访问

    用以对开启ES现有集群的kibana公网访问权限

    输入示例

    POST / HTTP/1.1
    Host: es.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UpdateInstancePublicAccess
    <公共请求参数>
    
    {
        "WebNodeTypeInfo": {
            "NodeNum": 1,
            "NodeType": "1"
        },
        "KibanaAlteringPublicAccess": [
            "1"
        ],
        "MasterNodeType": "1",
        "EsConfigSet": {
            "Type": "1",
            "EsConfig": "1"
        },
        "NodeNum": 1,
        "EnableCerebro": true,
        "MasterNodeDiskSize": 1,
        "CerebroPublicAccess": "1",
        "EsPublicAcl": {
            "BlackIpList": [
                "1"
            ],
            "WhiteIpList": [
                "1"
            ]
        },
        "KibanaPublicAccess": "1",
        "KibanaPrivateAccess": "1",
        "InstanceId": "1",
        "OperationDuration": {
            "TimeStart": "1",
            "TimeZone": "1",
            "MoreInstances": [
                "1"
            ],
            "Periods": [
                1
            ],
            "TimeEnd": "1"
        },
        "BasicSecurityType": 0,
        "CosBackup": {
            "IsAutoBackup": true,
            "BackupTime": "1"
        },
        "MasterNodeNum": 1,
        "CerebroPrivateAccess": "1",
        "SceneType": 0,
        "Password": "1",
        "ScaleType": 0,
        "NodeInfoList": [
            {
                "LocalDiskInfo": {
                    "LocalDiskType": "1",
                    "LocalDiskSize": 1,
                    "LocalDiskCount": 1
                },
                "NodeType": "1",
                "DiskEncrypt": 1,
                "DiskCount": 1,
                "DiskType": "1",
                "CpuNum": 1,
                "NodeNum": 1,
                "DiskSize": 1,
                "MemSize": 0,
                "Type": "1"
            }
        ],
        "KibanaPrivatePort": 1,
        "MultiZoneInfo": [
            {
                "SubnetId": "1",
                "Zone": "1"
            }
        ],
        "EsConfig": "1",
        "DiskSize": 1,
        "SwitchPrivateLink": "1",
        "InstanceName": "1",
        "EsAcl": {
            "BlackIpList": [
                "1"
            ],
            "WhiteIpList": [
                "1.1.1.1"
            ]
        },
        "NodeType": "1",
        "PublicAccess": "1",
        "ForceRestart": true,
        "KibanaConfig": "1"
    }

    输出示例

    {
        "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。

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.EsDictionaryInfoError 由于EsDictionaryInfo错误,不允许操纵。
    FailedOperation.UnsupportedLocalDiskRollUpScaleUpOrDown 不支持对本地盘集群通过滚动重启方式扩缩容。
    FailedOperation.UnsupportedResetNodeTypeAndScaleOutDisk 不支持在滚动重启扩容计算资源同时扩容磁盘数量。
    FailedOperation.UnsupportedRestScaleDownAndModifyDisk 不支持在滚动重启缩容计算资源同时修改磁盘大小
    FailedOperation.UnsupportedReverseRegulationNodeTypeAndDisk 不支持反向调节节点配置和磁盘容量。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidAppId AppId的取值和预期不符。
    InvalidParameter.InvalidCosBackupInfo cos自动备份信息与预期不符。
    InvalidParameter.InvalidDiskCount 节点磁盘块数DiskCount取值和预期不符。
    InvalidParameter.InvalidDiskEncrypt 节点磁盘加密信息DiskEncrypt的取值与预期不符。
    InvalidParameter.InvalidDiskType 节点磁盘类型DiskType的取值和预期不符。
    InvalidParameter.InvalidEsACL EsAcl的取值和预期不符。
    InvalidParameter.InvalidInstanceId 无效的InstanceId,没有找到对应资源。
    InvalidParameter.InvalidKibanaPrivatePort Kibana内网访问端口的取值和预期不符。
    InvalidParameter.InvalidMultiZoneInfo 多可用区部署ZoneDetail的信息与预期不符。
    InvalidParameter.InvalidNodeNum 节点数量NodeNum的取值和预期不符。
    InvalidParameter.InvalidNodeType 节点规格NodeType的取值和预期不符。
    InvalidParameter.InvalidPrivateAccess 内网访问PrivateAccess的取值和预期不符。
    InvalidParameter.InvalidPublicAccess 外网访问PublicAccess的取值和预期不符。
    InvalidParameter.InvalidSceneType 场景化模版类型SceneType的取值和预期不符。
    InvalidParameter.InvalidType 节点类型Type的取值和预期不符。
    InvalidParameter.InvalidUpdateType 更新类型UpdateType的取值和预期不符。
    InvalidParameter.InvalidZone 可用区Zone的信息与预期不符。
    InvalidParameterValue.EsConfigType ES配置类型取值有误。
    InvalidParameterValue.InstanceName 实例名校验失败,按规则输入。
    InvalidParameterValue.InvalidDeadline 截止日期冲突。
    InvalidParameterValue.Password 密码校验不合法。
    LimitExceeded.ResourceLimit 超出一个用户可以拥有的最大资源限制。
    LimitExceeded.UpdateItemLimit 更新参数值过多,超过限制。
    ResourceInUse 资源被占用。
    ResourceNotFound.ClusterInfoNotFound 集群资源获取失败。
    ResourceNotFound.DBInfoNotFound 数据库资源获取失败。
    ResourceNotFound.DiskInfoNotFound 磁盘相关资源获取失败。
    ResourceNotFound.NetWorkInfoNotFound 网络资源获取失败。
    ResourceNotFound.VPCInfoNotFound VPC资源获取失败。
    ResourceNotFound.WhiteListNotFound 白名单资源获取失败。
    UnauthorizedOperation.UinNotInWhiteList Uin不在白名单中。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.BasicSecurityType 不支持该认证方式。
    UnsupportedOperation.ChangeNodeType 不支持变配节点或磁盘的配置。
    UnsupportedOperation.InstanceTypeError 不支持该操作,服务类型有误。
    UnsupportedOperation.MultiZonesUpgrade 不支持多可用区变配。
    UnsupportedOperation.Plugin 不支持该插件。
    UnsupportedOperation.StatusNotNormal 不支持该操作,当前实例运行状态不为正常。
    UnsupportedOperation.StatusNotSupport 不支持该操作,实例状态有误。
    UnsupportedOperation.SwitchPrivateLink 不支持切换PrivateLink架构。
    UnsupportedOperation.WebServiceType 不支持的web组件。