AI 助理
备案控制台
文档
输入文档关键字查找
首页 云原生数据库 PolarDB 开发参考 PolarDB MySQL版/PostgreSQL版API参考 API参考指南 API目录 从RDS迁移 DescribeDBClusterMigration - 查询PolarDB集群的迁移状态

DescribeDBClusterMigration - 查询PolarDB集群的迁移状态

更新时间：
产品详情
我的收藏

查询PolarDB集群的迁移状态。

接口说明

  • 该接口用于查询 RDS 一键迁移到 PolarDB 的迁移状态。详情请参见一键升级 RDS MySQL 到 PolarDB MySQL 版。

  • 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为 CreateDBCluster ，参数 CreationOption 的取值需为 MigrationFromRDS。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
DBClusterIdstring是

集群 ID。

pc-**************

返回参数

名称类型描述示例值
object
DBClusterEndpointListarray<object>

PolarDB 连接地址详情。

DBClusterEndpointobject
AddressItemsarray<object>

连接串详情。

Addressobject
VSwitchIdstring

虚拟交换机 ID。

vsw-**********
ConnectionStringstring

连接串。

pc-**************.rwlb.rds.aliyuncs.com
NetTypestring

连接串网络类型，取值范围如下：

  • Public：公网地址
  • Private：私网地址
  • Inner：私网地址（经典网络）
Private
Portstring

端口号。

3306
VPCIdstring

专有网络 ID。

vpc-**********
IPAddressstring

IP 地址。

192.***.***.10
SSLEnabledstring

是否开启 SSL 加密。取值如下：

  • Enabled：开启 SSL 加密。
  • Disabled：关闭 SSL 加密。
Enabled
DBEndpointIdstring

连接地址 ID。

pe-***********
EndpointTypestring

连接地址类型，取值范围如下：

  • Cluster：默认集群地址
  • Primary：主地址
  • Custom：自定义集群地址
Cluster
ReadWriteModestring

读写模式，取值范围如下：

  • ReadWrite：可读可写（自动读写分离）。
  • ReadOnly（默认）：只读。
ReadOnly
Commentstring

迁移异常的注释信息，若迁移无异常则返回空值。

test
RequestIdstring

请求 ID。

F2A9EFA7-915F-4572-8299-85A307******
ExpiredTimestring

RDS 与 PolarDB 之间的复制关系到期时间，格式为YYYY-MM-DDThh:mm:ssZ（UTC 时间）。

2020-06-17T01:56:36Z
DBClusterIdstring

集群 ID。

pc-****************
Topologiesstring

同步关系，取值范围如下：

  • RDS2POLARDB：从 RDS 到 PolarDB 同步
  • POLARDB2RDS：从 PolarDB 到 RDS 同步
RDS2POLARDB
RdsReadWriteModestring

源 RDS 实例读写模式，取值范围如下：

  • rw：读写
  • ro：只读
rw
SourceRDSDBInstanceIdstring

源 RDS 实例 ID。

rm-************
DBClusterReadWriteModestring

集群读写模式，取值范围如下：

  • rw：读写。
  • ro：只读。
ro
DelayedSecondsinteger

RDS 与 PolarDB 之间的复制延迟时间，单位为秒。

0
MigrationStatusstring

PolarDB 集群的迁移状态，取值范围如下：

  • NO_MIGRATION：没有迁移任务。
  • RDS2POLARDB_CLONING：数据克隆中。
  • RDS2POLARDB_SYNCING：数据同步中，此时 PolarDB 的读写状态为只读，RDS 的读写状态为可读可写。
  • SWITCHING：数据库切换中。
  • POLARDB2RDS_SYNCING：数据库切换完成，此时 PolarDB 的读写状态为可读可写，RDS 的读写状态为只读。您可以修改应用内的连接地址。
  • ROLLBACK：迁移回滚中，回滚完成后，状态变更为RDS2POLARDB_SYNCING。
  • CLOSING_MIGRATION：关闭迁移任务中。
RDS2POLARDB_SYNCING
DtsInstanceIdstring

同步任务 ID。

dts**********618bs
RdsEndpointListarray<object>

RDS 连接地址详情。

RdsEndpointobject
AddressItemsarray<object>

连接串详情。

Addressobject
VSwitchIdstring

虚拟交换机 ID。

vsw-**************
ConnectionStringstring

连接串。

rm-***********.mysql.rds.aliyuncs.com
NetTypestring

连接串网络类型，取值范围如下：

  • Public：公网地址
  • Private：私网地址
  • Inner：私网地址（经典网络）
Private
Portstring

端口号。

3306
VPCIdstring

专有网络 ID。

vpc-************
IPAddressstring

IP 地址。

172.***.***.173
SSLEnabledstring

是否开启 SSL 加密。取值如下：

  • Enabled：开启 SSL 加密。
  • Disabled：关闭 SSL 加密。
Enabled
DBEndpointIdstring

连接地址 ID。

rm-************-normal
EndpointTypestring

连接地址类型，取值范围如下：

  • Normal：普通地址
  • ReadWriteSplitting：读写分离地址
Normal
CustinsTypestring

实例类型

ReadOnly Maxscale Primary
SrcDbTypestring

源数据库类型。取值如下：

  • PolarDBMySQL：PolarDB 大版本升级迁移时的源数据库类型。
  • RDS：将数据从 RDS 迁移至 PolarDB MySQL 时的源数据类型。
PolarDBMySQL

示例

正常返回示例

JSON格式

{
  "DBClusterEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**********",
          "ConnectionString": "pc-**************.rwlb.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-**********",
          "IPAddress": "192.***.***.10",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "pe-***********",
      "EndpointType": "Cluster",
      "ReadWriteMode": "ReadOnly"
    }
  ],
  "Comment": "test",
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******",
  "ExpiredTime": "2020-06-17T01:56:36Z",
  "DBClusterId": "pc-****************",
  "Topologies": "RDS2POLARDB",
  "RdsReadWriteMode": "rw",
  "SourceRDSDBInstanceId": "rm-************",
  "DBClusterReadWriteMode": "ro",
  "DelayedSeconds": 0,
  "MigrationStatus": "RDS2POLARDB_SYNCING",
  "DtsInstanceId": "dts**********618bs",
  "RdsEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**************",
          "ConnectionString": "rm-***********.mysql.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-************",
          "IPAddress": "172.***.***.173",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "rm-************-normal",
      "EndpointType": "Normal",
      "CustinsType": "ReadOnly\nMaxscale\nPrimary"
    }
  ],
  "SrcDbType": "PolarDBMySQL"
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。

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

变更历史

变更时间变更内容概要操作
2023-12-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-09-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-07-06OpenAPI 返回结构发生变更查看变更详情
上一篇：从RDS迁移下一篇：ModifyDBClusterMigration - 切换或回滚迁移任务
文档推荐