DescribeDBClusterMigration - PolarDB

Queries the migration status of PolarDB clusters.

Operation description

The ID of the request.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDBClusterMigration	get	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The network type of the endpoint. Valid values: Public: the public endpoint Private: the internal endpoint (VPC) Inner: the internal endpoint (classic network)	pc-**************

Response parameters

Parameter	Type	Description	Example
	object
DBClusterEndpointList	array<object>	The port number.
DBClusterEndpoint	object
AddressItems	array<object>	The VPC ID.
Address	object
VSwitchId	string	The IP address of the endpoint.	vsw-**********
ConnectionString	string	Indicates whether SSL encryption is enabled. Valid values: Enabled Disabled	pc-**************.rwlb.rds.aliyuncs.com
NetType	string	The ID of the endpoint.	Private
Port	string	The type of the endpoint. Valid values: Cluster: the default cluster endpoint Primary: the primary endpoint Custom: the custom endpoint	3306
VPCId	string	The read/write mode. Valid values: ReadWrite: receives and forwards read and write requests (automatic read-write splitting). ReadOnly (default): receives and forwards read requests only.	vpc-**********
IPAddress	string	The description of a migration exception. If no exception occurs during the migration, an empty string is returned.	192.*.*.10
SSLEnabled	string	The ID of the request.	Enabled
DBEndpointId	string	The expiration time of the replication between ApsaraDB RDS and PolarDB. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.	pe-***********
EndpointType	string	The ID of the cluster.	Cluster
ReadWriteMode	string	The synchronization direction. Valid values: RDS2POLARDB: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster. POLARDB2RDS: Data is replicated from a PolarDB cluster to an ApsaraDB RDS instance.	ReadOnly
Comment	string	The mode of the source ApsaraDB RDS instance. Valid values: rw: read and write mode ro: read-only mode	test
RequestId	string	The ID of the source ApsaraDB RDS instance.	F2A9EFA7-915F-4572-8299-85A307******
ExpiredTime	string	The mode of the PolarDB cluster. Valid values: rw: read and write mode ro: read-only mode	2020-06-17T01:56:36Z
DBClusterId	string	The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.	pc-****************
Topologies	string	The migration state of the PolarDB cluster. Valid values: NO_MIGRATION: No migration task is running. RDS2POLARDB_CLONING: Data is being replicated. RDS2POLARDB_SYNCING: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode. SWITCHING: Databases are being switched. POLARDB2RDS_SYNCING: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications. ROLLBACK: The migration is being rolled back. After the rollback is complete, the value RDS2POLARDB_SYNCING is returned. CLOSING_MIGRATION: The migration task is being terminated.	RDS2POLARDB
RdsReadWriteMode	string	The ID of the synchronous task.	rw
SourceRDSDBInstanceId	string	The endpoints of the ApsaraDB RDS instance.	rm-************
DBClusterReadWriteMode	string	Details about the endpoints.	ro
DelayedSeconds	integer	The vSwitch ID.	0
MigrationStatus	string	The endpoint.	RDS2POLARDB_SYNCING
DtsInstanceId	string	The network type of the endpoint. Valid values: Public: the public endpoint Private: the internal endpoint (VPC) Inner: the internal endpoint (classic network)	dts**********618bs
RdsEndpointList	array<object>	The port number.
RdsEndpoint	object
AddressItems	array<object>	The VPC ID.
Address	object
VSwitchId	string	The IP address of the endpoint.	vsw-**************
ConnectionString	string	Indicates whether SSL encryption is enabled. Valid values: Enabled Disabled	rm-***********.mysql.rds.aliyuncs.com
NetType	string	The ID of the endpoint.	Private
Port	string	The type of the endpoint. Valid values: Normal: the standard endpoint ReadWriteSplitting: the read/write splitting endpoint	3306
VPCId	string	The instance type.	vpc-************
IPAddress	string	The type of the source database. Valid values: PolarDBMySQL: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded. RDS: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.	172.*.*.173

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-22	The Error code has changed. The response structure of the API has changed	View Change Details
2022-09-08	The Error code has changed. The response structure of the API has changed	View Change Details
2022-07-06	The response structure of the API has changed	View Change Details