调用MigrateAvailableZone接口迁移实例可用区-云数据库 MongoDB 版-阿里云

迁移MongoDB实例的可用区。

接口说明

MigrateAvailableZone 接口暂不支持单节点实例，可适用于云盘实例与本地盘实例。
实例未开启透明数据加密 TDE 功能。
迁移的目标可用区和当前实例的可用区处于同一地域。
专有网络的实例在操作迁移可用区之前，请确保目标可用区已创建相应的虚拟交换机。如需创建，请参见创建虚拟交换机。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:MigrateAvailableZone

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明如果实例的网络类型为专有网络，您还需要传入 Vswitch 参数。	dds-bp1ece71ff2f****
ZoneId	string	是	迁移的目标可用区 ID。说明迁移的目标可用区和当前实例的可用区处于同一地域。您可以通过调用 DescribeRegions 接口查询可用区 ID。	cn-hangzhou-b
Vswitch	string	否	迁移的目标可用区虚拟交换机 ID。说明当实例的网络类型为专有网络时，需要配置该参数。	vsw-bp1buy0h9myt5i9e7****
EffectiveTime	string	否	迁移可用区的生效时间，取值： Immediately：立即生效。 MaintainTime：在实例的可运维时间段内生效。默认为 Immediately。	Immediately
SecondaryZoneId	string	否	迁移的目标备可用区 1 的 ID。	cn-hangzhou-h
HiddenZoneId	string	否	迁移的目标备可用区 2 的 ID。	cn-shanghai-n

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	0FDDC511-7252-4A4A-ADDA-5CB1BF63****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidEffectiveTime.Malformed	Specified EffectiveTime is not valid.
400	InsType.NotSupport	Specified instance type dose not support this operation.	指定的实例类型不支持此操作。
400	IncorrectMasterDBInstanceState	The Master instance state does not support this operation.
400	NetworkTypeNotSupport	The network type does not support this operation.	该网络类型不支持此操作。
400	OperationDenied.LockMode	The operation is not permitted when the instance locked.
400	InvalidIzNo.NotSupported	the Specified vpc Zone not supported.
400	IncorrectVswitchId	The specified parameter 'VSwitchId' is not valid.	当前实例为VPC实例时，VSwitchId 参数不能为空。
400	InvalidRegion_Zone_NotFound	Specified Region does not exist in RDS.
400	VPCERROR.ALLOCATE_ERROR	Cannot Allocate the require vpcInstances.
400	ProxyError	The request processing has failed due to some unknown error, exception or failure.
400	DbInsertError	Database insert error.
400	UnsupportedDBTdeStatus	Specified DB TDEStatus does not support this operation.
400	InvalidZoneParam	The target zone and source zone cannot be the same.	目标可用区不可以和原可用区一致
400	MigrateDBInstanceError	Error in migrating available area or changing your vpc network. Please submit the work order for processing.	迁移可用区或变更专有网络时发生错误，请提交工单处理。
400	MinorVersionNotSupport	Instance's MinorVersion is not supported for this API.	此API不支持实例的MinorVersion。
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

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

变更历史

更多信息，参考变更详情。