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.	该请求使用与先前相同但不相同的请求相同的客户端令牌。除非请求相同，否则请勿将客户端令牌与其他请求重用。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。