文档

SwitchInstanceProxy - 开启或关闭Redis集群实例的代理模式

更新时间:

开启或关闭专属集群中Redis集群实例的代理模式。

接口说明

关于代理模式的详细介绍,请参见Redis Proxy 特性说明。 调用本接口时,需满足下述条件:

说明 调用本接口前,您需要调用 DescribeDedicatedClusterInstanceList 接口,通过返回参数 ProxyCount 的值来判断当前实例是否开启了代理模式。例如,返回值为 0 时,表示未开启代理模式;返回值大于 0 时,即表示已开启代理模式。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:SwitchInstanceProxyupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5D622714-AEDD-4609-9167-F5DDD3D1****

示例

正常返回示例

JSON格式

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

JSON格式

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 描述信息更新查看变更详情