有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

重启ES集群实例(用于系统版本更新等操作)

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RestartInstance。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:es-xxxxxxxx
ForceRestart Boolean 是否强制重启
  • true:强制重启
  • false:不强制重启
  • 默认false
    示例值:false
    RestartMode Integer 重启模式:0 滚动重启; 1 全量重启
    示例值:0
    UpgradeKernel Boolean 重启时选择是否升级内核patch版本
    示例值:false

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 重启ES集群实例

    用以进行版本更新等操作

    输入示例

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

    输出示例

    {
        "Response": {
            "RequestId": "7f0e35a7-e03b-42cd-aa4f-0c1471xxxxxx"
        }
    }

    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 集群状态错误。
    InternalError 内部错误。
    InvalidParameter.InvalidAppId AppId的取值和预期不符。
    InvalidParameter.InvalidEsVersion 实例版本EsVersion的取值和预期不符。
    InvalidParameter.InvalidInstanceId 无效的InstanceId,没有找到对应资源。
    InvalidParameterValue.ConfigInfo 组件配置值有误。
    ResourceNotFound.ClusterInfoNotFound 集群资源获取失败。
    ResourceNotFound.DBInfoNotFound 数据库资源获取失败。
    UnsupportedOperation.ClusterStateNoReplication 集群中存在部分索引无备份。
    UnsupportedOperation.ClusterStateUnHealth 集群的状态不正常(不为绿)。
    UnsupportedOperation.InstanceTypeError 不支持该操作,服务类型有误。
    UnsupportedOperation.StatusNotNormal 不支持该操作,当前实例运行状态不为正常。
    UnsupportedOperation.StatusNotSupport 不支持该操作,实例状态有误。