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

关于代理模式的详细介绍,请参见Redis Proxy特性说明

调用本接口时,需满足下述条件:

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

调试

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

请求参数

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

系统规定的参数,取值:SwitchInstanceProxy

InstanceId String r-bp1zxszhcgatnx****

实例ID,可调用DescribeInstances获取。

RegionId String cn-hangzhou

实例所属地域的ID,您可以调用DescribeInstanceAttribute接口查询。

返回数据

名称 类型 示例值 描述
RequestId String 5D622714-AEDD-4609-9167-F5DDD3D1****

请求ID。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=SwitchInstanceProxy
&InstanceId=r-bp1zxszhcgatnx****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<SwitchInstanceProxyResponse>
	  <RequestId>5D622714-AEDD-4609-9167-F5DDD3D1****</RequestId>
</SwitchInstanceProxyResponse>

JSON格式

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

错误码

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