文档

MigrateDBInstance - 迁移主机组内的RDS实例

更新时间:

调用MigrateDBInstance接口迁移专属集群内的RDS实例。

接口说明

专属集群功能以集群形式批量管理实例,一个地域可以创建多个专属集群,一个专属集群包含多个主机,一个主机包含多个实例。详情请参见专属集群简介

调试

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

调试

授权信息

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

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

请求参数

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

地域 ID。可以通过接口 DescribeRegions 查看地域 ID。

cn-hangzhou
DedicatedHostGroupIdstring

专属集群 ID。可调用 DescribeDedicatedHostGroups 获取。

dhg-4nxxxxxxx
DBInstanceIdstring

实例 ID。

rm-uf6wjk5xxxxxxx
TargetDedicatedHostIdForMasterstring

主实例要迁移的目标主机 ID。可调用 DescribeDedicatedHosts 获取。

i-bpxxxxxxx1
TargetDedicatedHostIdForSlavestring

备实例要迁移的目标主机 ID。可调用 DescribeDedicatedHosts 获取。

i-bpxxxxxxx2
EffectiveTimestring

迁移时间。取值:

  • Immediately:立即切换(默认)
  • MaintainTime:在运维时间段切换
  • Specified:指定时间切换
MaintainTime
SpecifiedTimestring

指定切换的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 EffectiveTime=Specified 时需要填入本参数。
2019-10-21T10:00:00Z
ZoneIdForLogstring

日志节点的可用区 ID。

cn-hangzhou-i
ZoneIdForFollowerstring

备节点的可用区 ID。

cn-hangzhou-h

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

498AE8CA-8C81-4A01-AF37-2B902014ED30
TaskIdinteger

任务 ID。

108246861
MigrationIdinteger

迁移排队序号。当序号为 0 时,就会进行迁移切换。

2245016

示例

正常返回示例

JSON格式

{
  "RequestId": "498AE8CA-8C81-4A01-AF37-2B902014ED30",
  "TaskId": 108246861,
  "MigrationId": 2245016
}

错误码

HTTP status code错误码错误信息描述
400GeneralIns.CreatingThe general instance is creating.目前有实例还在生产中,请稍等
400GeneralIns.MaintainingThe general instance is maintaining.有实例在迁移或维护中,请稍等
400GeneralIns.SwitchingThe general instance is Switching.HA切换中,请稍等
400InvalidTargetDedicatedHostId.NotFoundThe target dedicated host ID is invalid.目标主机ID无效,请确认目标主机ID的正确性及目标主机的可用性。
400InvalidMasterHostNameThe specified master host zoneId is different from the master zoneId.主机可用区ID与主可用区ID不一致。
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。
400InvalidPrimaryCustinsStatusPrimary DBInstance status is not Active.操作失败,只读实例所属主实例状态必须是运行中才可以执行该操作。
403OperationDenied.PrimaryDBInstanceStatusThe operation is not permitted due to status of primary instance.操作失败,无法迁移专属集群内非运行状态的RDS实例。
404InsufficientResourceCapacityNo host is available for the requested instance.目标可用区没有足够的资源。
404InvalidParamThe specified parameter is invalid.无效参数。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
404AllocateResourceFailedFailed to allocate resources. Please check the zone and the host you selected.资源申请失败,请检查所选可用区、主机是否足够分配对应的规格资源。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈