迁移MongoDB实例到其他可用区。
接口说明
- 本接口适用于副本集实例，暂不支持单节点实例和分片集群实例。
- 实例未开启透明数据加密 TDE 功能。
- 迁移的目标可用区和当前实例的可用区处于同一地域。
- 专有网络的实例在操作迁移可用区之前，请确保目标可用区已创建相应的虚拟交换机，如需创建请参见创建虚拟交换机。
- 如果实例申请了公网连接地址，需要先调用 ReleasePublicNetworkAddress 接口释放公网连接地址。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:MigrateToOtherZone | update | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID。
如果实例的网络类型为专有网络，您还需要传入 VSwitchId 参数。
| dds-bp2658**** |
| ZoneId | string | 是 | 迁移的目标可用区 ID。 | cn-hangzhou-b |
| EffectiveTime | string | 否 | 迁移可用区的生效时间，取值：
| Immediately |
| VSwitchId | string | 否 | 迁移的目标可用区虚拟交换机 ID。
当实例的网络类型为专有网络时，本参数才可用且必须传入。
| vsw-bp67ac**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidEffectiveTime.Malformed | Specified EffectiveTime is not valid. | EffectiveTime 参数为空。 |
| 400 | MigrateDBInstanceError | Error in migrating available area or changing your vpc network. Please submit the work order for processing. | 迁移可用区或变更专有网络时发生错误，请提交工单处理。 |
访问错误中心查看更多错误码。
