全部產品
Search
文件中心

:ModifyDBClusterMigration - 切換或復原遷移任務

更新時間:Dec 12, 2025

切換或復原RDS一鍵升級到PolarDB的遷移任務。

介面說明

  • 在切換前調用該介面會進行切換。

  • 在切換完成後調用該介面會進行復原。

說明

調用該介面時,叢集必須已經建立了一鍵升級任務。建立一鍵升級任務的介面為 CreateDBCluster ,參數 CreationOption 取值需為 MigrationFromRDS。更多資訊,請參見一鍵升級 RDS MySQL 到 PolarDB MySQL 版

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyDBClusterMigration

update

*dbcluster

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

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

PolarDB 叢集 ID。

pc-**************

SourceRDSDBInstanceId

string

源 RDS 執行個體 ID。

rm-************

NewMasterInstanceId

string

新的執行個體 ID 或叢集 ID,取值範圍如下:

  • 切換前,填寫 PolarDB 叢集 ID 進行切換。

  • 切換後,填寫 RDS 執行個體 ID 進行復原。

pc-**************

SwapConnectionString

string

是否需要切換串連地址,取值:

  • true:帶地址切換(應用程式不用改串連配置)。

  • false:不帶地址切換(應用程式需要改為新的 PolarDB 串連配置)。

預設為 false

false

ConnectionStrings

string

需要切換的具體串連地址。取值為需要兩兩交換的地址對應的 JSON 串。

說明

當 SwapConnectionString 取值為 true 時生效。

{"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"}

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

A1B303A5-653F-4AEE-A598-023FF9******

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A1B303A5-653F-4AEE-A598-023FF9******"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidConnectionString.Malformed The specified parameter ConnectionString is not valid. 指定的參數ConnectionString無效。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

變更歷史

更多資訊,參考變更詳情