调用SwitchNetwork切换Redis实例的网络类型,仅支持从经典网络切换为VPC网络。

该API对应的控制台操作请参见切换为专有网络

调试

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

请求参数

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

系统规定参数,取值:SwitchNetwork

InstanceId String r-bp1zxszhcgatnx****

实例ID。

TargetNetworkType String VPC

需要切换到的网络类型,当前仅支持经典网络切换到专有网络,取值固定为VPC

VpcId String vpc-bp1nme44gek34slfc****

要切换到的目标专有网络ID。

说明 传入本参数后,您还需要传入VSwitchId参数。
RetainClassic String True

是否保留经典网络连接地址,取值:

  • True:保留。
  • False:不保留。
说明 默认值为False
VSwitchId String vsw-bp1e7clcw529l773d****

要切换到的目标专有网络下的虚拟交换机ID。

ClassicExpiredDays String 30

保留经典网络IP的时间,取值:143060120,单位为天。

说明
  • RetainClassic取值为True,本参数才可用且必须传入。
  • 切换到VPC网络后,如需修改经典网络IP的保留时间请参见ModifyInstanceNetExpireTime
RegionId String cn-hangzhou

实例所属的地域ID。

返回数据

名称 类型 示例值 描述
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 InvalidToken.Malformed The Specified parameter "Token" is not valid. Token验证失败
400 IzNotSupportVpcError Specify iz not support vpc. 指定 iz不支持Vpc。
400 IzNotSupportSwitchNetworkError Specify iz not support switch network. 指定 iz不支持交换网络。
400 VpcId is wrong. VpcId is wrong. VPC ID错误。

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