CloseEngineMigration - PolarDB

此介面用於關閉指定執行個體的資料庫引擎遷移流程。當使用者啟動從其他資料庫（如自建 MySQL、RDS 等）向 PolarDB-X 的資料遷移任務後，若需中途終止或清理遷移狀態，可透過此介面安全停止遷移過程。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:CloseEngineMigration

none

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceName	string	是	執行個體名稱。	pxc-htri0****r4k9p
RegionId	string	否	地域 ID。	cn-hangzhou
ContinueEnableBinlog	string	否	是否繼續開啟 Binlog，取值範圍如下： true：繼續開啟 Binlog false：關閉 Binlog 預設值為 true。說明關閉 Binlog 將會重新啟動您的 PolarDB 叢集。	true

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	C458B1E8-1683-3645-B154-6BA32080EEA
Code	string	介面返回 Code。	200
Message	string	成功時為空，失敗時返回錯誤資訊。	*****
HttpStatusCode	string	請求狀態碼。	200
SuccessResponse	string	請求是否成功。	true
Data	object	新的位址連結字串資訊。
DBInstanceName	string	執行個體 ID。	pxc-hzjasd****
TaskId	string	後端任務 ID。	2209883

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Code": "200",
  "Message": "*****",
  "HttpStatusCode": "200",
  "SuccessResponse": "true",
  "Data": {
    "DBInstanceName": "pxc-hzjasd****",
    "TaskId": "2209883"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

變更歷史

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