调用MigrateDBInstance接口迁移专属集群内的RDS实例。
接口说明
专属集群功能以集群形式批量管理实例,一个地域可以创建多个专属集群,一个专属集群包含多个主机,一个主机包含多个实例。详情请参见专属集群简介。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:MigrateDBInstance | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域ID。可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
DedicatedHostGroupId | string | 是 | 专属集群ID。可调用DescribeDedicatedHostGroups获取。 | dhg-4nxxxxxxx |
DBInstanceId | string | 是 | 实例ID。 | rm-uf6wjk5xxxxxxx |
TargetDedicatedHostIdForMaster | string | 否 | 主实例要迁移的目标主机ID。可调用DescribeDedicatedHosts获取。 | i-bpxxxxxxx1 |
TargetDedicatedHostIdForSlave | string | 否 | 备实例要迁移的目标主机ID。可调用DescribeDedicatedHosts获取。 | i-bpxxxxxxx2 |
EffectiveTime | string | 否 | 迁移时间。取值:
| MaintainTime |
SpecifiedTime | string | 否 | 指定切换的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明当EffectiveTime=Specified时需要填入本参数。 | 2019-10-21T10:00:00Z |
ZoneIdForLog | string | 否 | 日志节点的可用区ID。 | cn-hangzhou-i |
ZoneIdForFollower | string | 否 | 备节点的可用区ID。 | cn-hangzhou-h |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "498AE8CA-8C81-4A01-AF37-2B902014ED30",
"TaskId": 108246861,
"MigrationId": 2245016
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTargetDedicatedHostId.NotFound | The target dedicated host ID is invalid. | 目标主机ID无效,请确认目标主机ID的正确性及目标主机的可用性。 |
400 | InvalidMasterHostName | The specified master host zoneId is different from the master zoneId. | 主机可用区ID与主可用区ID不一致。 |
400 | InvalidDBInstanceName.NotFound | The specified DB instance name does not exist. | 数据库实例名称不存在,请检查。 |
400 | InvalidPrimaryCustinsStatus | Primary DBInstance status is not Active. | 操作失败,只读实例所属主实例状态必须是运行中才可以执行该操作。 |
403 | OperationDenied.PrimaryDBInstanceStatus | The operation is not permitted due to status of primary instance. | 操作失败,无法迁移专属集群内非运行状态的RDS实例。 |
404 | InsufficientResourceCapacity | No host is available for the requested instance. | 目标可用区没有足够的资源。 |
404 | InvalidParam | The specified parameter is invalid. | 参数不合法 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
404 | AllocateResourceFailed | Failed to allocate resources. Please check the zone and the host you selected. | 资源申请失败,请检查所选可用区、主机是否足够分配对应的规格资源。 |
访问错误中心查看更多错误码。