You need to enable JavaScript to run this app.
导航
RestartInstance - 重启目标实例
最近更新时间:2024.09.19 16:49:55首次发布时间:2023.11.30 14:19:27

调用 RestartInstance 接口,重启实例中的所有节点。

请求说明

  • 实例重启过程中,部分服务将不可用,建议您在低峰期执行重启操作。
  • 正常的重启需要实例处于一个健康的状态,当实例内有索引处于不健康的状态时,重启将无法继续进行。此时如果您仍然想要执行重启动作,则需要进行一次强制重启,但是无视集群状态进行的强制重启可能会导致部分传输数据丢失或者实例不可用,请谨慎操作。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

RestartInstance

要执行的操作,取值:RestartInstance。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-00k***o718

需要重启的实例 ID。

Force
Boolean

false

标识是否是一次强制重启,默认为false,取值说明如下:

  • true:此次操作强制重启实例。
  • false:此次操作非强制重启。
  • 返回参数

    下表仅列出本接口特有的返回参数。更多信息请参见返回结构

    参数
    类型
    示例值
    描述
    TaskId
    String

    edc9bbcf802*****9a3abac9edde

    返回的任务 ID。

    InstanceId
    String

    o-00k***o718

    重启实例的 ID。

    请求示例

    POST https://open.volcengineapi.com/?Action=RestartInstance&Version=2023-01-01
    Content-Type: application/json
    X-Date: 20231003T104027Z
    Authorization: HMAC-SHA256 
    Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
    {
        "InstanceId": "o-00k***o718",
        "Force": false
    }
    

    返回示例

    {
        "ResponseMetadata": {
            "Action": "RestartInstance",
            "Version": "2023-01-01",
            "RequestId": "2023060411042001001002322***",
            "Service": "ESCloud",
            "Region": "cn-beijing"
        },
        "Result": {
            "InstanceId": "o-00k***o718",
            "TaskId": "edc9bbcf802*****9a3abac9edde"
        }
    }
    

    错误码

    下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

    状态码
    错误码
    错误信息
    说明
    200
    IllegalParameter
    illegal parameter

    非法参数。可能是参数缺失,也可能是参数不符合接口要求

    200
    InternalServerError
    服务器内部异常

    服务由于异常退出,无法完成接口请求操作

    200
    Unauthorized
    unauthorized error

    用户无权限调用接口