重启ES集群实例

最近更新时间:2019-07-24 15:19:04

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RestartInstance
Version String 公共参数,本接口取值:2018-04-16
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
ForceRestart Boolean 是否强制重启
  • true:强制重启
  • false:不强制重启
  • 默认false

    3. 输出参数

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

    4. 示例

    示例1 重启ES集群实例

    用以进行版本更新等操作

    输入示例

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

    输出示例

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

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    ResourceInUse 资源被占用。