DescribeDBClusterMigration - 云原生数据库 PolarDB MySQL版

该接口用于查询RDS一键迁移到PolarDB的迁移状态。详情请参见一键升级RDS MySQL到PolarDB MySQL版。
调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为CreateDBCluster，参数CreationOption的取值需为MigrationFromRDS。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBClusterMigration	系统规定参数。取值：DescribeDBClusterMigration。
DBClusterId	String	是	pc-**************	集群ID。

返回数据


名称	类型	示例值	描述
DBClusterEndpointList	Array of DBClusterEndpoint		PolarDB连接地址详情。
AddressItems	Array of Address		连接串详情。
VSwitchId	String	vsw-**********	虚拟交换机ID。
ConnectionString	String	pc-**************.rwlb.rds.aliyuncs.com	连接串。
NetType	String	Private	连接串网络类型，取值范围如下： Public：公网地址 Private：私网地址 Inner：私网地址（经典网络）
Port	String	3306	端口号。
VPCId	String	vpc-**********	专有网络ID。
IPAddress	String	192.*.*.10	IP地址。
SSLEnabled	String	Enabled	是否开启SSL加密。取值如下： Enabled：开启SSL加密。 Disabled：关闭SSL加密。
DBEndpointId	String	pe-***********	连接地址ID。
EndpointType	String	Cluster	连接地址类型，取值范围如下： Cluster：默认集群地址 Primary：主地址 Custom：自定义集群地址
Comment	String	test	迁移异常的注释信息，若迁移无异常则返回空值。
RequestId	String	F2A9EFA7-915F-4572-8299-85A307******	请求ID。
ExpiredTime	String	2020-06-17T01:56:36Z	RDS与PolarDB之间的复制关系到期时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。
DBClusterId	String	pc-****************	集群ID。
Topologies	String	RDS2POLARDB	同步关系，取值范围如下： RDS2POLARDB：从RDS到PolarDB同步 POLARDB2RDS：从PolarDB到RDS同步
RdsReadWriteMode	String	rw	源RDS实例读写模式，取值范围如下： rw：读写 ro：只读
SourceRDSDBInstanceId	String	rm-************	源RDS实例ID。
DBClusterReadWriteMode	String	ro	集群读写模式，取值范围如下： rw：读写。 ro：只读。
DelayedSeconds	Integer	0	RDS与PolarDB之间的复制延迟时间，单位为秒。
MigrationStatus	String	RDS2POLARDB_SYNCING	PolarDB集群的迁移状态，取值范围如下： NO_MIGRATION：没有迁移任务。 RDS2POLARDB_CLONING：数据克隆中。 RDS2POLARDB_SYNCING：数据同步中，此时PolarDB的读写状态为只读，RDS的读写状态为可读可写。 SWITCHING：数据库切换中。 POLARDB2RDS_SYNCING：数据库切换完成，此时PolarDB的读写状态为可读可写，RDS的读写状态为只读。您可以修改应用内的连接地址。 ROLLBACK：迁移回滚中，回滚完成后，状态变更为RDS2POLARDB_SYNCING。 CLOSING_MIGRATION：关闭迁移任务中。
DtsInstanceId	String	dts**********618bs	同步任务ID。
RdsEndpointList	Array of RdsEndpoint		RDS连接地址详情。
AddressItems	Array of Address		连接串详情。
VSwitchId	String	vsw-**************	虚拟交换机ID。
ConnectionString	String	rm-***********.mysql.rds.aliyuncs.com	连接串。
NetType	String	Private	连接串网络类型，取值范围如下： Public：公网地址 Private：私网地址 Inner：私网地址（经典网络）
Port	String	3306	端口号。
VPCId	String	vpc-************	专有网络ID。
IPAddress	String	172.*.*.173	IP地址。
SSLEnabled	String	Enabled	是否开启SSL加密。取值如下： Enabled：开启SSL加密。 Disabled：关闭SSL加密。
DBEndpointId	String	rm-************-normal	连接地址ID。
EndpointType	String	Normal	连接地址类型，取值范围如下： Normal：普通地址 ReadWriteSplitting：读写分离地址
SrcDbType	String	PolarDBMySQL	源数据库类型。取值如下： PolarDBMySQL：PolarDB大版本升级迁移时的源数据库类型。 RDS：将数据从RDS迁移至PolarDB MySQL时的源数据类型。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterMigration
&DBClusterId=pc-**************
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterMigrationResponse>
    <DBClusterEndpointList>
        <AddressItems>
            <VSwitchId>vsw-**********</VSwitchId>
            <ConnectionString>pc-**************.rwlb.rds.aliyuncs.com</ConnectionString>
            <NetType>Private</NetType>
            <Port>3306</Port>
            <VPCId>vpc-**********</VPCId>
            <IPAddress>192.***.***.10</IPAddress>
            <SSLEnabled>"true"</SSLEnabled>
        </AddressItems>
        <DBEndpointId>pe-***********</DBEndpointId>
        <EndpointType>Cluster</EndpointType>
    </DBClusterEndpointList>
    <Comment>test</Comment>
    <RequestId>F2A9EFA7-915F-4572-8299-85A307******</RequestId>
    <ExpiredTime>2020-06-17T01:56:36Z</ExpiredTime>
    <DBClusterId>pc-****************</DBClusterId>
    <Topologies>RDS2POLARDB</Topologies>
    <RdsReadWriteMode>rw</RdsReadWriteMode>
    <SourceRDSDBInstanceId>rm-************</SourceRDSDBInstanceId>
    <DBClusterReadWriteMode>ro</DBClusterReadWriteMode>
    <DelayedSeconds>0</DelayedSeconds>
    <MigrationStatus>RDS2POLARDB_SYNCING</MigrationStatus>
    <DtsInstanceId>dts**********618bs</DtsInstanceId>
    <RdsEndpointList>
        <AddressItems>
            <VSwitchId>vsw-**************</VSwitchId>
            <ConnectionString>rm-***********.mysql.rds.aliyuncs.com</ConnectionString>
            <NetType>Private</NetType>
            <Port>3306</Port>
            <VPCId>vpc-************</VPCId>
            <IPAddress>172.***.***.173</IPAddress>
            <SSLEnabled>"true"</SSLEnabled>
        </AddressItems>
        <DBEndpointId>rm-************-normal</DBEndpointId>
        <EndpointType>Normal</EndpointType>
    </RdsEndpointList>
</DescribeDBClusterMigrationResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBClusterEndpointList" : [ {
    "AddressItems" : [ {
      "VSwitchId" : "vsw-**********",
      "ConnectionString" : "pc-**************.rwlb.rds.aliyuncs.com",
      "NetType" : "Private",
      "Port" : "3306",
      "VPCId" : "vpc-**********",
      "IPAddress" : "192.***.***.10",
      "SSLEnabled" : "\"true\""
    } ],
    "DBEndpointId" : "pe-***********",
    "EndpointType" : "Cluster"
  } ],
  "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" : "\"true\""
    } ],
    "DBEndpointId" : "rm-************-normal",
    "EndpointType" : "Normal"
  } ]
}

错误码


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

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