Ringkasan API Status Migrasi Kluster PolarDB - PolarDB - Alibaba Cloud - PolarDB

Mengkueri status migrasi kluster PolarDB Basis Data Relasional Cloud-Native.

Deskripsi operasi

You can use this operation to query the status of a one-click migration from an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster. For more information, see Upgrade an ApsaraDB RDS for MySQL instance to PolarDB for MySQL.
Before you call this operation, you must create a one-click upgrade task for the cluster by calling the CreateDBCluster operation and setting the CreationOption parameter to MigrationFromRDS.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBClusterMigration

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-**************

Elemen respons

Element	Type	Description	Example
	object
DBClusterEndpointList	array<object>	The details of the PolarDB endpoints.
	array<object>
AddressItems	array<object>	The details of the connection strings.
	object
VSwitchId	string	The ID of the virtual switch.	vsw-**********
ConnectionString	string	The connection string.	pc-**************.rwlb.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public: An endpoint for the Internet. Private: A private endpoint. Inner: A private endpoint in a classic network.	Private
Port	string	The port.	3306
VPCId	string	The ID of the virtual private cloud (VPC).	vpc-**********
IPAddress	string	The IP address.	192.*.*.10
SSLEnabled	string	Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values: Enabled: SSL encryption is enabled. Disabled: SSL encryption is disabled.	Enabled
DBEndpointId	string	The endpoint ID.	pe-***********
EndpointType	string	The type of the endpoint. Valid values: Cluster: The default cluster endpoint. Primary: The primary endpoint. Custom: A custom cluster endpoint.	Cluster
ReadWriteMode	string	The read/write mode. Valid values: ReadWrite: Read and write (automatic read/write splitting). ReadOnly (Default): Read-only.	ReadOnly
Comment	string	The comments on the migration exception. If no exception occurs during the migration, an empty value is returned.	test
RequestId	string	The request ID.	F2A9EFA7-915F-4572-8299-85A307******
ExpiredTime	string	The time when the replication relationship between the ApsaraDB RDS instance and the PolarDB cluster expires. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is displayed in UTC.	2020-06-17T01:56:36Z
DBClusterId	string	The cluster ID.	pc-****************
Topologies	string	The data synchronization relationship. Valid values: RDS2POLARDB: Data is synchronized from the ApsaraDB RDS instance to the PolarDB cluster. POLARDB2RDS: Data is synchronized from the PolarDB cluster to the ApsaraDB RDS instance.	RDS2POLARDB
RdsReadWriteMode	string	The read/write mode of the source ApsaraDB RDS instance. Valid values: rw: Read and write. ro: Read-only.	rw
SourceRDSDBInstanceId	string	The ID of the source ApsaraDB RDS instance.	rm-************
DBClusterReadWriteMode	string	The read/write mode of the cluster. Valid values: rw: Read and write. ro: Read-only.	ro
DelayedSeconds	integer	The replication delay between the ApsaraDB RDS instance and the PolarDB cluster, in seconds.	0
MigrationStatus	string	The migration status of the PolarDB cluster. Valid values: NO_MIGRATION: No migration task is created. RDS2POLARDB_CLONING: Data is being cloned. RDS2POLARDB_SYNCING: Data is being synchronized. In this state, the PolarDB cluster is read-only, and the ApsaraDB RDS instance is read-write. SWITCHING: The database is being switched. POLARDB2RDS_SYNCING: The database switch is complete. In this state, the PolarDB cluster is read-write, and the ApsaraDB RDS instance is read-only. Change the endpoints in your application. ROLLBACK: The migration is being rolled back. After the rollback is complete, the migration status changes to RDS2POLARDB_SYNCING. CLOSING_MIGRATION: The migration task is being shut down.	RDS2POLARDB_SYNCING
DtsInstanceId	string	The ID of the sync task.	dts**********618bs
RdsEndpointList	array<object>	The details of the ApsaraDB RDS endpoints.
	array<object>
AddressItems	array<object>	The details of the connection strings.
	object
VSwitchId	string	The ID of the vSwitch.	vsw-**************
ConnectionString	string	The connection string.	rm-***********.mysql.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public: An endpoint for the Internet. Private: A private endpoint. Inner: A private endpoint in a classic network.	Private
Port	string	The port.	3306
VPCId	string	The ID of the VPC.	vpc-************
IPAddress	string	The IP address.	172.*.*.173
SSLEnabled	string	Indicates whether SSL encryption is enabled. Valid values: Enabled: SSL encryption is enabled. Disabled: SSL encryption is disabled.	Enabled
DBEndpointId	string	The endpoint ID.	rm-************-normal
EndpointType	string	The type of the endpoint. Valid values: Normal: A regular endpoint. ReadWriteSplitting: A read/write splitting endpoint.	Normal
CustinsType	string	The instance type.	ReadOnly Maxscale Primary
SrcDbType	string	The type of the source database. Valid values: PolarDBMySQL: The source database for a major version upgrade of a PolarDB cluster. RDS: The source database for migrating data from an ApsaraDB RDS instance to a PolarDB for MySQL cluster.	PolarDBMySQL

Contoh

Respons sukses

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.