You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

RestartDBInstance

最近更新时间：2023.03.15 15:51:32

首次发布时间：2021.11.15 16:07:16

我的收藏

调用 RestartDBInstance 接口重启指定的 Redis 实例。

请求类型

异步请求。

注意事项

  • 仅实例状态为运行中（Running）的实例支持重启操作。
  • 实例重启过程中，部分服务的访问在短时间内会受到影响，请谨慎操作。
  • 建议在业务低峰期执行重启操作，并确保应用具备自动重连机制。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=RestartDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"redis-cn0212gzmh2xs****"
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151543190102120372302566****",
          "Action": "RestartDBInstance",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

更多详情，请参见错误码。