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:DescribeDBClusterMigration

get

*dbcluster

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	pc-**************

返回參數

名稱	類型	描述	樣本值
	object
DBClusterEndpointList	array<object>	PolarDB 串連地址詳情。
	array<object>
AddressItems	array<object>	串連串詳情。
	object
VSwitchId	string	虛擬交換器 ID。	vsw-**********
ConnectionString	string	串連串。	pc-**************.rwlb.rds.aliyuncs.com
NetType	string	串連串網路類型，取值範圍如下： Public：公網地址 Private：私網地址 Inner：私網地址（傳統網路）	Private
Port	string	連接埠號碼。	3306
VPCId	string	專用網路 ID。	vpc-**********
IPAddress	string	IP 位址。	192.*.*.10
SSLEnabled	string	是否開啟 SSL 加密。取值如下： Enabled：開啟 SSL 加密。 Disabled：關閉 SSL 加密。	Enabled
DBEndpointId	string	串連地址 ID。	pe-***********
EndpointType	string	串連地址類型，取值範圍如下： Cluster：預設叢集地址 Primary：主地址 Custom：自訂叢集地址	Cluster
ReadWriteMode	string	讀寫入模式，取值範圍如下： ReadWrite：可讀可寫（自動讀寫分離）。 ReadOnly（預設）：唯讀。	ReadOnly
Comment	string	遷移異常的注釋資訊，若遷移無異常則返回空值。	test
RequestId	string	請求 ID。	F2A9EFA7-915F-4572-8299-85A307******
ExpiredTime	string	RDS 與 PolarDB 之間的複製關係到期時間，格式為`YYYY-MM-DDThh:mm:ssZ`（UTC 時間）。	2020-06-17T01:56:36Z
DBClusterId	string	叢集 ID。	pc-****************
Topologies	string	同步關係，取值範圍如下： RDS2POLARDB：從 RDS 到 PolarDB 同步 POLARDB2RDS：從 PolarDB 到 RDS 同步	RDS2POLARDB
RdsReadWriteMode	string	源 RDS 執行個體讀寫入模式，取值範圍如下： rw：讀寫 ro：唯讀	rw
SourceRDSDBInstanceId	string	源 RDS 執行個體 ID。	rm-************
DBClusterReadWriteMode	string	叢集讀寫入模式，取值範圍如下： rw：讀寫。 ro：唯讀。	ro
DelayedSeconds	integer	RDS 與 PolarDB 之間的複寫延遲時間，單位為秒。	0
MigrationStatus	string	PolarDB 叢集的遷移狀態，取值範圍如下： NO_MIGRATION：沒有遷移任務。 RDS2POLARDB_CLONING：資料複製中。 RDS2POLARDB_SYNCING：資料同步中，此時 PolarDB 的讀寫狀態為唯讀，RDS 的讀寫狀態為可讀可寫。 SWITCHING：資料庫切換中。 POLARDB2RDS_SYNCING：資料庫切換完成，此時 PolarDB 的讀寫狀態為可讀可寫，RDS 的讀寫狀態為唯讀。您可以修改應用內的串連地址。 ROLLBACK：遷移復原中，復原完成後，狀態變更為RDS2POLARDB_SYNCING。 CLOSING_MIGRATION：關閉遷移任務中。	RDS2POLARDB_SYNCING
DtsInstanceId	string	同步任務 ID。	dts**********618bs
RdsEndpointList	array<object>	RDS 串連地址詳情。
	array<object>
AddressItems	array<object>	串連串詳情。
	object
VSwitchId	string	虛擬交換器 ID。	vsw-**************
ConnectionString	string	串連串。	rm-***********.mysql.rds.aliyuncs.com
NetType	string	串連串網路類型，取值範圍如下： Public：公網地址 Private：私網地址 Inner：私網地址（傳統網路）	Private
Port	string	連接埠號碼。	3306
VPCId	string	專用網路 ID。	vpc-************
IPAddress	string	IP 位址。	172.*.*.173
SSLEnabled	string	是否開啟 SSL 加密。取值如下： Enabled：開啟 SSL 加密。 Disabled：關閉 SSL 加密。	Enabled
DBEndpointId	string	串連地址 ID。	rm-************-normal
EndpointType	string	串連地址類型，取值範圍如下： Normal：普通地址 ReadWriteSplitting：讀寫分離地址	Normal
CustinsType	string	執行個體類型	ReadOnly Maxscale Primary
SrcDbType	string	來源資料庫類型。取值如下： 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	錯誤碼	錯誤資訊	描述
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的 DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。