文档

MigrateAvailableZone - 迁移实例的可用区

迁移MongoDB实例的可用区。

接口说明

  • MigrateAvailableZone 接口适用于 MongoDB 4.2 及以下版本的副本集实例,分片集群实例,暂不支持单节点实例。
  • 如果实例申请了公网连接地址,需要先调用 ReleasePublicNetworkAddress 接口释放公网连接地址。
  • 实例未开启透明数据加密 TDE 功能。
  • 迁移的目标可用区和当前实例的可用区处于同一地域。
  • 专有网络的实例在操作迁移可用区之前,请确保目标可用区已创建相应的虚拟交换机。如需创建,请参见创建虚拟交换机

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 如果实例的网络类型为专有网络,您还需要传入 Vswitch 参数。
dds-bp1ece71ff2f****
ZoneIdstring

迁移的目标可用区 ID。

说明
  • 迁移的目标可用区和当前实例的可用区处于同一地域。
  • 您可以通过调用 DescribeRegions 接口查询可用区 ID。
  • cn-hangzhou-b
    Vswitchstring

    迁移的目标可用区虚拟交换机 ID。

    说明 当实例的网络类型为专有网络时,需要配置该参数。
    vsw-bp1buy0h9myt5i9e7****
    EffectiveTimestring

    迁移可用区的生效时间,取值:

    • Immediately:立即生效。
    • MaintainTime:在实例的可运维时间段内生效。

    默认为 Immediately

    Immediately

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    0FDDC511-7252-4A4A-ADDA-5CB1BF63****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidEffectiveTime.MalformedSpecified EffectiveTime is not valid.-
    400InsType.NotSupportSpecified instance type dose not support this operation.-
    400IncorrectMasterDBInstanceStateThe Master instance state does not support this operation.-
    400NetworkTypeNotSupportThe network type does not support this operation.该网络类型不支持此操作。
    400OperationDenied.LockModeThe operation is not permitted when the instance locked.当前实例已被锁定,无法执行该操作。
    400InvalidIzNo.NotSupportedthe Specified vpc Zone not supported.-
    400IncorrectVswitchIdThe specified parameter 'VSwitchId' is not valid.-
    400InvalidRegion_Zone_NotFoundSpecified Region does not exist in RDS.-
    400VPCERROR.ALLOCATE_ERRORCannot Allocate the require vpcInstances.-
    400ProxyErrorThe request processing has failed due to some unknown error, exception or failure.-
    400DbInsertErrorDatabase insert error.-
    400UnsupportedDBTdeStatusSpecified DB TDEStatus does not support this operation.指定实例已开启TDE,不支持此操作
    404InvalidDbInstanceId.NotFoundSpecified instance does not exist.该实例不存在,原因可能是该实例已经释放,请刷新页面。

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

    变更历史

    变更时间变更内容概要操作
    2023-07-13OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    • 本页导读 (1)
    文档反馈