MigrateToOtherZone - 迁移实例至其他可用区

更新时间:

将云数据库 Tair(兼容 Redis)实例迁移到同地域内的其它可用区。

接口说明

执行本接口前需要先释放公网连接地址等,更多信息请参见迁移可用区

说明
  • 如果实例是从经典网络切换到专有网络的,并且保留了经典网络的连接地址,则需等到经典网络连接地址到期释放后才能执行可用区迁移。
  • 迁移之后实例的连接地址不会改变,但 VIP 会发生变化,请在业务中使用连接地址连接实例而非其 VIP 地址。
  • 调试

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

    授权信息

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

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    kvstore:MigrateToOtherZoneupdate
    • DBInstance
      acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    请求参数

    名称类型必填描述示例值
    DBInstanceIdstring

    实例 ID。

    r-bp1zxszhcgatnx****
    ZoneIdstring

    要迁移到的目标主可用区 ID,可调用 DescribeZones 接口查询。

    cn-hangzhou-g
    VSwitchIdstring

    虚拟交换机的 ID 。

    说明
  • vSwitch 所在可用区须与 ZoneId(目的可用区)一致;
  • 如果实例的网络类型为 VPC,则该参数为必选。
  • vsw-bp1e7clcw529l773d****
    EffectiveTimestring

    数据迁移后执行数据库切换的时间,取值:

    • Immediately:迁移完立即切换。
    • MaintainTime:在可维护时间段内切换。
    说明 默认值:Immediately
    枚举值:
    • 0
    • 1
    • Immediately
    • MaintainTime
    Immediately
    SecondaryZoneIdstring

    要迁移到的目标备可用区 ID,可调用 DescribeZones 接口查询。

    说明 传入本参数可以实现主备数据节点分布在不同的可用区,实现跨可用区容灾,可承受机房级别的故障。
    cn-hangzhou-h

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    29B0BF34-D069-4495-92C7-FA6D9452****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "29B0BF34-D069-4495-92C7-FA6D9452****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400NetworkType.NotSupportSpecified network type does not support this operation.当前实例已开启公网访问/直连访问,暂不支持此操作.请关闭公网访问/直连访问后执行此操作
    400InstanceStatus.NotSupportInstance status does not support this operation.当前实例状态不支持此操作
    400MissingSwitchIdVSwitchId is mandatory for this action.-
    400IzNotSupportVpcErrorSpecify zone not support VPC.-
    400InvalidReginAvzNotFoundSpecified user does not find the region and zone.-
    400ClusterNotSupportThe Specified cluster does not support.-
    400InvalidVSwitchId.MismatchThe Specified vSwitchId does not matched VPC.VSwitchId和VPC不匹配,请检查VSwitchId配置。
    400InvalidIzNo.NotSupportedThe Specified Zone does not supported.-
    404DBInstanceNotFoundSpecified instance does not exist.-
    500VpcServiceErrorInvoke VPC service failed.-
    500ZoneMigrationError.StillingRunningZone migration task is still running.-

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

    变更历史

    变更时间变更内容概要操作
    2023-07-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情