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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String r-j6cxxxxxxxxxxxxxx

需要切换网络类型的实例的ID。

Action String SwitchNetwork

系统规定参数,取值:SwitchNetwork。

TargetNetworkType String VPC

需要切换到的网络类型,当前仅支持经典网络切换到VPC,因此该参数仅有默认值VPC。

VpcId String vpc-bp1xxxxxxxxxxxxxxxxxx

实例切换到VPC网络后所属的VPC ID。

VSwitchId String vsw-sdrxxxxxxxxxxxxxxxxxx

实例切换网络类型后VPC内的交换机ID,如果传入了VpcId则此参数为必选。

RetainClassic String True

是否保留经典网络 IP:

  • True(保留)
  • False(不保留)
说明 默认值为False。
ClassicExpiredDays String 30

保留经典网络IP的时间,单位:天。 可选值:14、30、60、120。若选择保留经典网络地址,则该参数必选。

说明 切换到VPC网络后,如需修改经典网络IP的保留时间请参见ModifyInstanceNetExpireTime
AccessKeyId String Lxxxxxxxxxxxxxxw

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

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

任务ID。

RequestId String F0997EE8-F4C2-4503-9168-85177ED78C70

请求ID。

示例

请求示例


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

正常返回示例

XML 格式

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

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidToken.Malformed The Specified parameter "Token" is not valid. Token验证失败
400 VpcServiceError Invoke vpc service failed. 调用vpc服务失败。
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. VpcId错误

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