调用SwitchNetwork切换Redis实例的专有网络VPC或交换机，如果Redis实例为经典网络，则会将其切换为专有网络。

调试

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

请求参数

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

系统规定参数，取值：SwitchNetwork。

InstanceId String 是 r-bp1zxszhcgatnx****

实例ID，可调用DescribeInstances获取。

VpcId String 是 vpc-bp1nme44gek34slfc****

要切换到的目标专有网络ID，可调用专有网络VPC的DescribeVpcs获取。

说明
  • 目标专有网络所属的地域需和Redis实例相同。
  • 传入本参数后，您还需要传入VSwitchId参数。
VSwitchId String 是 vsw-bp1e7clcw529l773d****

要切换到的目标专有网络下的虚拟交换机ID，可调用专有网络VPC的DescribeVpcs获取。

说明 目标虚拟交换机所属的可用区需和Redis实例相同。
TargetNetworkType String 否 VPC

需要切换到的网络类型，取值固定为VPC，即专有网络。

RetainClassic String 否 True

如果实例当前为经典网络，将其切换至专有网络时，是否保留原经典网络连接地址，取值：

  • True：保留。
  • False：默认值，不保留。
说明 当实例的网络类型为经典网络时，本参数才可用。
ClassicExpiredDays String 否 30

经典网络连接地址的保留时间，取值：14、30、60、120，单位为天。

说明
  • 当RetainClassic取值为True，本参数才可用且必须传入。
  • 完成切换后，您还可以调用ModifyInstanceNetExpireTime修改经典网络连接地址的保留时间。
RegionId String 否 cn-hangzhou

实例所属地域的ID，可调用DescribeInstances获取。

返回数据

名称 类型 示例值 描述
TaskId String 578678678

任务ID。
RequestId String F0997EE8-F4C2-4503-9168-85177ED78C70

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com?Action=SwitchNetwork
&InstanceId=r-bp1zxszhcgatnx****
&TargetNetworkType=VPC
&VpcId=vpc-bp1nme44gek34slfc****
&VSwitchId=vsw-bp1e7clcw529l773d****
&RetainClassic=True
&ClassicExpiredDays=30
&<公共请求参数>

正常返回示例

XML格式 

<SwitchNetworkResponse>
      <TaskId>578678678</TaskId>
      <requestId>F0997EE8-F4C2-4503-9168-85177ED78C70</requestId>
</SwitchNetworkResponse>

JSON格式 

{   
    "TaskId":"578678678",
    "requestId": "F0997EE8-F4C2-4503-9168-85177ED78C70"
}

错误码

HttpCode 错误码 错误信息 描述
400 IzNotSupportVpcError Specify iz not support vpc. 指定 iz不支持Vpc。
400 IzNotSupportSwitchNetworkError Specify iz not support switch network. 指定 iz不支持交换网络。

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