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

RestartDBInstanceProxy

最近更新时间：2023.11.29 10:25:31

首次发布时间：2023.11.29 10:25:31

我的收藏

调用 RestartDBInstanceProxy 接口重启一个或多个代理节点（Proxy Node）。

请求类型

异步请求。

注意事项

重启代理节点会对已有连接产生影响，请在业务低峰期进行操作，并确保业务具备重连机制。

请求参数

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

InstanceId

String

是

redis-cn0212gzmh2xs****

实例 ID。

说明

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

ProxyNodeIds

Array of String

是

["proxy-redis-cnlfml47ag4fg5j2a-0"]

Proxy 的节点 ID，支持同时传入多个节点，多个节点间用英文逗号（,）分隔。

说明

您可以调用 DescribeNodeIds 接口查询目标实例包含的所有节点信息，包括 Proxy 节点 ID 信息。

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

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=RestartDBInstanceProxy&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****",
    "ProxyNodeIds": [
        "proxy-redis-cn0212gzmh2xs****-0",
        "proxy-redis-cn0212gzmh2xs****-1"
    ]
}

返回示例

正常返回示例

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

错误码

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