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

调用 RestartNode 接口,重启实例的目标成员节点。

注意事项

重启实例成员节点,整个实例处于重启中状态。实例重启过程中,部分服务将不可用,建议您在业务低峰期重启实例成员节点。

请求说明

  • 请求方式:POST
  • 请求地址:/?Action=RestartNode&Version=2023-01-01 HTTP/1.1

调试

请求参数

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

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

RestartNode

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

Version
String

2023-01-01

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

InstanceId
String

o-00k***o718

需要重启节点的实例 ID。

Force
Boolean

false

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

  • true:此次操作强制重启实例。
  • false:此次操作非强制重启。
  • NodeName
    String

    es-master-00****o718-0

    需要重启的成员节点 ID。
    您可以调用 DescribeInstanceNodes 接口获取成员节点列表,然后选择需要重启的节点。

    返回参数

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

    参数
    类型
    示例值
    描述
    TaskId
    String

    2e132b847****7cd1451e49a

    返回的任务 ID。

    NodeName
    String

    es-master-00****o718-0

    重启节点的名称。

    InstanceId
    String

    o-00k***o718

    重启节点所属实例的 ID。

    请求示例

    POST https://open.volcengineapi.com/?Action=RestartNode&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",
        "NodeName": "es-master-00****o718-0",
        "Force": false
    }
    

    返回示例

    {
        "ResponseMetadata": {
            "Action": "RestartNode",
            "Region": "cn-beijing",
            "RequestId": "202306041104200100100232**",
            "Service": "ESCloud",
            "Version": "2023-01-01"
        },
        "Result": {
            "NodeName": "es-master-00****o718-0",
            "TaskId": "2e132b847****7cd1451e49a",
            "InstanceId": "o-00k***o718"
        }
    }
    

    错误码

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

    状态码
    错误码
    错误信息
    说明
    200
    InternalServerError
    服务器内部异常

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

    200
    IllegalParameter
    illegal parameter

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

    200
    Unauthorized
    unauthorized error

    用户无权限调用接口