RestartInstance_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 重启后,实例进入生效中(activing)状态。重启成功后,实例状态变为正常(active)。阿里云 Elasticsearch 支持单节点重启,节点重启分为普通重启和蓝绿重启。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:RestartInstance
None
Instance
acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

请求语法

POST /openapi/instances/{InstanceId}/actions/restart HTTP/1.1

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-nif1q8auz0003****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
forceboolean

是否忽略集群状态,强制重启。

示例值:false
clientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不值过 64 个 ASCII 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

RequestBody

RequestBody 中还需填入以下参数,用来指定重启参数信息。

| 名称 | 类型 | 是否必选 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | restartType | String | 否 | instance |重启类型。可选值:
instance(默认):实例重启。
nodeIp:节点重启,需要指定节点的 IP 地址。
nodeEcsId:节点重启,需要指定集群中 ECS 实例的 ID。| | nodes | List | 否| ["127.0.0.1"] |选择节点重启时,指定待重启的节点的 IP 地址或 ID。| | blueGreenDep | Boolean | 否 | false |节点重启时,是否启用蓝绿部署,默认值为 false。| | batchCount | Double | 否| 25.0 | 实例强制重启时,设置的并发度。| | batchUnit | String | 否 | percent |batchCount 的单位,默认为 percent。|

说明
  • restartType 不传或者传空字符串时,默认为 instance。为 instance 时,默认忽略 blueGreenDep 参数,并且需要满足以下条件: * forcetrue 时,batchCount 必须大于 0,小于等于 100,否则会报错 RestartBatchValueError。 * forcefalse 时,batchCount 默认为 0,设置为其他值时,会报错 NormalRestartNotSupportBatch。
    • restartTypenodeIp 时,默认忽略 batchCount 参数,并且需要满足以下条件:
      • nodes 不可为空,否则提醒参数错误。
      • blueGreenDeptrue 时,在重启节点时,会启用蓝绿部署。为 false 时,不会启用蓝绿部署,即正常重启。

    示例如下。

    {
        "restartType":"nodeIp",
        "nodes":["172.16.xx.xx","172.16.xx.xx"],
        "blueGreenDep":true
    }
    

    返回参数

    字段名称字段详情
    RequestIdstring

    请求 ID。

    示例值:F99407AB-2FA9-489E-A259-40CF6DC****
    Resultobject

    返回结果。

    返回说明

    以下返回示例中,本文只保证包含返回数据列表中的参数,而未提到的参数仅供参考,程序中不能强制依赖获取这些参数。

    返回示例

    错误返回示例

    错误码

    全局错误码
    HTTP 状态码错误码错误信息操作
    400
    InstanceActivating
    Instance is activating诊断
    400
    InstanceNotFound
    The instanceId provided does not exist诊断

    变更历史

    暂无变更历史

    相关示例

    ElasticSearch OpenAPI 控制台管控SDK示例,阿里云ElasticSearch 实例创建和管控API CodeSample
    2022-07-04