You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

RestartInstance - 重启目标实例

最近更新时间：2024.04.09 15:04:00

首次发布时间：2023.11.30 14:19:27

我的收藏

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

注意事项

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

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是RestartInstance接口名称。当前 API 的名称为 RestartInstance。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
ForceBoolean否false标识是否是一次强制重启，默认为false，取值说明如下：
  • true：此次操作强制重启实例。
  • false：此次操作非强制重启。
    • InstanceIdString是o-00k***o718需要重启的实例 ID。

    返回参数

    参数类型示例值描述
    TaskIdStringedc9bbcf802*****9a3abac9edde返回的任务 ID。
    InstanceIdStringo-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"
    }
}