该接口用于查询PolarDB集群的迁移状态。

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterMigration

系统规定参数,取值:DescribeDBClusterMigration

DBClusterId String pc-bpxxxxxxx

PolarDB集群ID。

RegionId String cn-hangzhou

地域ID,如cn-hangzhou。

返回数据

名称 类型 示例值 描述
Comment String xxxxxx

迁移异常的注释信息。

DBClusterEndpointList Array

PolarDB连接地址列表。

AddressItems Array

连接串信息。

ConnectionString String pc-bpxxxxxxxxxx.rwlb.rds.aliyuncs.com

连接串。

IPAddress String 192.xx.xx.10

IP地址。

NetType String Private

连接串网络类型,取值:

  • Public:公网地址。
  • Private:私网地址。
  • Inner:私网地址(经典网络)。
Port String 3306

端口。

VPCId String vpc-bpxxxxxxxxxx

专有网络ID。

VSwitchId String vsw-bpxxxxxxxxxx

虚拟交换机ID。

DBEndpointId String pe-bpxxxxxxxxxx

连接地址ID。

EndpointType String Cluster

连接地址类型,取值:

  • Cluster:默认集群地址。
  • Primary:主地址。
  • Custom:自定义集群地址。
DBClusterId String pc-bpxxxxxxx

PolarDB集群ID。

DBClusterReadWriteMode String ro

PolarDB集群读写模式。

  • rw:读写。
  • ro:只读。
DelayedSeconds Integer 0

RDS与PolarDB之间的复制延迟时间,单位:秒。

ExpiredTime String 2020-06-17T01:56:36Z

RDS与PolarDB之间复制关系到期时间,格式:YYYY-MM-DDThh:mm:ssZ(UTC时间)。

MigrationStatus String RDS2POLARDB_SYNCING

迁移状态,取值:

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

RDS连接地址列表。

AddressItems Array

连接串信息。

ConnectionString String rm-bpxxxxxxxxxx.mysql.rds.aliyuncs.com

连接串。

IPAddress String 172.xx.xx.173

IP地址。

NetType String Private

连接串网络类型,取值如下:

  • Public:公网地址。
  • Private:私网地址。
  • Inner:私网地址(经典网络)。
Port String 3306

端口。

VPCId String vpc-bpxxxxxxxxxxxx

专有网络ID。

VSwitchId String vsw-bpxxxxxxxxxx

虚拟交换机ID。

DBEndpointId String rm-bpxxxxxxxxx-normal

连接地址ID。

EndpointType String Normal

连接地址类型,取值如下:

  • Normal:普通地址。
  • ReadWriteSplitting:读写分离地址。
RdsReadWriteMode String rw

源RDS实例读写模式。

  • rw:读写。
  • ro:只读。
RequestId String F2A9EFA7-915F-4572-8299-85A307F6A658

请求ID。

SourceRDSDBInstanceId String rm-bpxxxxxxxxxx

源RDS实例ID。

Topologies String RDS2POLARDB

同步关系,取值:

  • RDS2POLARDB(从RDS到PolarDB同步)。
  • POLARDB2RDS(从PolarDB到RDS同步)。

示例

请求示例

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

正常返回示例

XML 格式

<DBClusterEndpointList>
    <DBEndpointId>pe-bpxxxxxxxxxx</DBEndpointId>
    <EndpointType>Cluster</EndpointType>
    <AddressItems>
        <VPCId>vpc-bpxxxxxxxxxx</VPCId>
        <Port>3306</Port>
        <VSwitchId>vsw-bpxxxxxxxxxx</VSwitchId>
        <ConnectionString>pc-bpxxxxxxxxxx.rwlb.rds.aliyuncs.com</ConnectionString>
        <IPAddress>192.xx.xx.10</IPAddress>
        <NetType>Private</NetType>
    </AddressItems>
</DBClusterEndpointList>
<DBClusterEndpointList>
    <DBEndpointId>pe-bpxxxxxxxxxxx</DBEndpointId>
    <EndpointType>Primary</EndpointType>
    <AddressItems>
        <VPCId>vpc-bpxxxxxxxxxx</VPCId>
        <Port>3306</Port>
        <VSwitchId>vsw-bpxxxxxxxxxx</VSwitchId>
        <ConnectionString>pc-bpxxxxxxxxxx.mysql.polardb.rds.aliyuncs.com</ConnectionString>
        <IPAddress>192.xx.xx.4</IPAddress>
        <NetType>Private</NetType>
    </AddressItems>
</DBClusterEndpointList>
<Comment/>
<RequestId>F2A9EFA7-915F-4572-8299-85A307F6A658</RequestId>
<ExpiredTime>2020-06-17T01:56:36Z</ExpiredTime>
<DBClusterId>pc-bpxxxxxxx</DBClusterId>
<Topologies>RDS2POLARDB</Topologies>
<RdsReadWriteMode>rw</RdsReadWriteMode>
<SourceRDSDBInstanceId>rm-bpxxxxxxxxxx</SourceRDSDBInstanceId>
<DBClusterReadWriteMode>ro</DBClusterReadWriteMode>
<DelayedSeconds>0</DelayedSeconds>
<MigrationStatus>RDS2POLARDB_SYNCING</MigrationStatus>
<RdsEndpointList>
    <DBEndpointId>rm-bpxxxxxxxxx-normal</DBEndpointId>
    <EndpointType>Normal</EndpointType>
    <AddressItems>
        <VPCId>vpc-bpxxxxxxxxxxxx</VPCId>
        <Port>3306</Port>
        <VSwitchId>vsw-bpxxxxxxxxxx</VSwitchId>
        <ConnectionString>rm-bpxxxxxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
        <IPAddress>172.xx.xx.173</IPAddress>
        <NetType>Private</NetType>
    </AddressItems>
</RdsEndpointList>
<RdsEndpointList>
    <DBEndpointId>rm-bpxxxxxxxxx-normal</DBEndpointId>
    <EndpointType>Normal</EndpointType>
    <AddressItems>
        <VPCId/>
        <Port>3306</Port>
        <VSwitchId/>
        <ConnectionString>rm-bpxxxxxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
        <IPAddress>101.xx.xx.19</IPAddress>
        <NetType>Public</NetType>
    </AddressItems>
</RdsEndpointList>

JSON 格式

{
	"DBClusterEndpointList": [
		{
			"DBEndpointId": "pe-bpxxxxxxxxxx",
			"EndpointType": "Cluster",
			"AddressItems": [
				{
					"VPCId": "vpc-bpxxxxxxxxxx",
					"Port": "3306",
					"VSwitchId": "vsw-bpxxxxxxxxxx",
					"ConnectionString": "pc-bpxxxxxxxxxx.rwlb.rds.aliyuncs.com",
					"IPAddress": "192.xx.xx.10",
					"NetType": "Private"
				}
			]
		},
		{
			"DBEndpointId": "pe-bpxxxxxxxxxxx",
			"EndpointType": "Primary",
			"AddressItems": [
				{
					"VPCId": "vpc-bpxxxxxxxxxx",
					"Port": "3306",
					"VSwitchId": "vsw-bpxxxxxxxxxx",
					"ConnectionString": "pc-bpxxxxxxxxxx.mysql.polardb.rds.aliyuncs.com",
					"IPAddress": "192.xx.xx.4",
					"NetType": "Private"
				}
			]
		}
	],
	"Comment": "",
	"RequestId": "F2A9EFA7-915F-4572-8299-85A307F6A658",
	"ExpiredTime": "2020-06-17T01:56:36Z",
	"DBClusterId": "pc-bpxxxxxxx",
	"Topologies": "RDS2POLARDB",
	"RdsReadWriteMode": "rw",
	"SourceRDSDBInstanceId": "rm-bpxxxxxxxxxx",
	"DBClusterReadWriteMode": "ro",
	"DelayedSeconds": 0,
	"MigrationStatus": "RDS2POLARDB_SYNCING",
	"RdsEndpointList": [
		{
			"DBEndpointId": "rm-bpxxxxxxxxx-normal",
			"EndpointType": "Normal",
			"AddressItems": [
				{
					"VPCId": "vpc-bpxxxxxxxxxxxx",
					"Port": "3306",
					"VSwitchId": "vsw-bpxxxxxxxxxx",
					"ConnectionString": "rm-bpxxxxxxxxxx.mysql.rds.aliyuncs.com",
					"IPAddress": "172.xx.xx.173",
					"NetType": "Private"
				}
			]
		},
		{
			"DBEndpointId": "rm-bpxxxxxxxxx-normal",
			"EndpointType": "Normal",
			"AddressItems": [
				{
					"VPCId": "",
					"Port": "3306",
					"VSwitchId": "",
					"ConnectionString": "rm-bpxxxxxxxxxx.mysql.rds.aliyuncs.com",
					"IPAddress": "101.xx.xx.19",
					"NetType": "Public"
				}
			]
		}
	]
}

错误码

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