调用MigrateAvailableZone接口迁移MongoDB实例的可用区。

使用说明

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

调试

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

请求参数

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

系统规定参数。取值:MigrateAvailableZone

DBInstanceId String dds-bp1ece71ff2f****

实例ID。

说明 如果实例的网络类型为专有网络,您还需要传入Vswitch参数。
ZoneId String cn-hangzhou-b

迁移的目标可用区ID。

说明
  • 迁移的目标可用区和当前实例的可用区处于同一地域。
  • 您可以通过调用DescribeRegions接口查询可用区ID。
Vswitch String vsw-bp1buy0h9myt5i9e7****

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

说明 当实例的网络类型为专有网络时,需要配置该参数。
EffectiveTime String Immediately

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

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

默认为Immediately

返回数据

名称 类型 示例值 描述
RequestId String 0FDDC511-7252-4A4A-ADDA-5CB1BF63****

请求ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=MigrateAvailableZone
&DBInstanceId=dds-bp1ece71ff2f****
&ZoneId=cn-hangzhou-b
&EffectiveTime=Immediately
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<MigrateAvailableZoneResponse>
    <RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63****</RequestId>
</MigrateAvailableZoneResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 UnsupportedDBTdeStatus Specified DB TDEStatus does not support this operation. 指定实例已开启TDE,不支持此操作

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