切換或回滾RDS一鍵升級到PolarDB的遷移任務(wù)。
接口說明
- 在切換前調(diào)用該接口會進(jìn)行切換。
- 在切換完成后調(diào)用該接口會進(jìn)行回滾。
說明
調(diào)用該接口時,集群必須已經(jīng)創(chuàng)建了一鍵升級任務(wù)。創(chuàng)建一鍵升級任務(wù)的接口為 CreateDBCluster ,參數(shù) CreationOption 取值需為 MigrationFromRDS。更多信息,請參見一鍵升級 RDS MySQL 到 PolarDB MySQL 版。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
polardb:ModifyDBClusterMigration | Write |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | PolarDB 集群 ID。 | pc-************** |
SourceRDSDBInstanceId | string | 是 | 源 RDS 實例 ID。 | rm-************ |
NewMasterInstanceId | string | 是 | 新的實例 ID 或集群 ID,取值范圍如下:
| pc-************** |
SwapConnectionString | string | 否 | 是否需要切換連接地址,取值:
默認(rèn)為 false。 | false |
ConnectionStrings | string | 否 | 需要切換的具體連接地址。取值為需要兩兩交換的地址對應(yīng)的 JSON 串。 說明
當(dāng) 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"} |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "A1B303A5-653F-4AEE-A598-023FF9******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidConnectionString.Malformed | The specified parameter ConnectionString is not valid. | 指定的參數(shù)ConnectionString無效。 |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當(dāng)前的記錄中不存在提供的DBClusterId。 |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當(dāng)前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 錯誤碼發(fā)生變更 | 看變更集 | ||||||||
| ||||||||||
2022-07-27 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 看變更集 | ||||||||
|