全部产品
Search
文档中心

云数据库 Tair(兼容 Redis®):SwitchNetwork - 切换专有网络VPC或交换机

更新时间:Aug 28, 2026

切换云数据库 Tair(兼容 Redis)实例的专有网络VPC或交换机,如果实例为经典网络,则会将其切换为专有网络。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:SwitchNetwork

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称

类型

必填

描述

示例值

TargetNetworkType

string

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

VPC

VpcId

string

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

说明
  • 目标专有网络所属的地域需和本实例相同。

  • 传入本参数后,您还需要传入 VSwitchId 参数。

vpc-bp1nme44gek34slfc****

VSwitchId

string

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

说明

目标虚拟交换机所属的可用区需和本实例相同。

vsw-bp1e7clcw529l773d****

InstanceId

string

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

RetainClassic

string

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

  • True:保留。

  • False:默认值,不保留。

说明

当实例的网络类型为经典网络时,本参数才可用。

True

ClassicExpiredDays

string

经典网络连接地址的保留时间,取值:143060120,单位为天。

说明
  • RetainClassic 取值为 True,本参数才可用且必须传入。

  • 完成切换后,您还可以调用 ModifyInstanceNetExpireTime 修改经典网络连接地址的保留时间。

30

返回参数

名称

类型

描述

示例值

object

TaskId

string

任务 ID。

578678678

RequestId

string

请求 ID。

F0997EE8-F4C2-4503-9168-85177ED78C70

示例

正常返回示例

JSON格式

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

异常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidToken.Malformed The Specified parameter Token is not valid.
400 VpcServiceError Invoke vpc service failed.
400 IzNotSupportVpcError Specify iz not support vpc.
400 IzNotSupportSwitchNetworkError Specify iz not support switch network.
400 VpcVerifyError VpcId is wrong.
400 VpcAndVSwitchNotChange VpcId and vSwitchId not change. VpcId和vSwitchId未更改。
403 ResourceAlreadyExists Resource already exists.
403 InsufficientResourceCapacity ip resource is conflict with other custins.
403 VpcFreePasswordNoSupport The custins opend VPCFreePassword not support this operation. 实例由于打开了VPC免密,或者在开了VPC免密同时又设置了#no_loose_check-whitelist-always参数为no暂不支持此操作。

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

变更历史

更多信息,参考变更详情