MigrateDBInstance - 实例可用区迁移

更新时间:
复制 MD 格式

该接口用于将实例从一个可用区迁移到另一个可用区。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:MigrateDBInstance

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

实例所属地域 ID。

cn-hangzhou

SwitchMode

string

否

切换模式。取值:

  • 0:立即切换。

  • 1:在可运维时间段内切换。

0

DBInstanceName

string

是

实例 ID。

pxc-xxx

TopologyType

string

是

拓扑类型:

  • 3azones:三可用区;

  • 1azone:单可用区。

3azones

PrimaryZoneId

string

是

多可用区实例,主可用区的可用区 ID。如果需要创建多可用区实例,该参数必填。

cn-zhangjiakou-b

SecondaryZoneId

string

否

备可用区 ID。

说明

本参数和 ZoneId 属性不能相同。

cn-beijing-l

TertiaryZoneId

string

否

第三可用区。

cn-beijing-h

VpcId

string

否

访问端点所在的专有网络 ID。

vpc-****

VswitchId

string

否

Vswitch ID, 创建 VPC 网络类型的 DRDS 时必须指定

vsw-****

返回参数

名称

类型

描述

示例值

object

MigrateDBInstanceResponse

Success

boolean

请求是否成功。

true

Message

string

成功返回 success,错误返回对应错误码。

*****

RequestId

string

请求 ID。

FEA5DC20-6D8A-5979-97AA-FC57546ADC20

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "*****",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20"
}

错误码

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

变更历史

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