1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口（CompleteMigrateJob）用于完成数据迁移任务。
选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。
通过DescribeMigrationJobs接口查询到任务的状态为准备完成（Status="readyComplete"）时，此时可以调用本接口完成迁移任务。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CompleteMigrateJob。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 数据迁移任务ID 示例值：dts-1kl0iy0v |
| CompleteMode | 否 | String | 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成，不会等待主从差距一致。默认为waitForSync 示例值：waitForSync |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 完成数据迁移任务
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CompleteMigrateJob
<公共请求参数>
{
"JobId": "dts-1kl0iy0v"
}输出示例
{
"Response": {
"RequestId": "5268ea15-6636-44d1-89f9-e989d1c82e7d"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.AuthFailureError | 认证失败。 |
| DryRunOperation.DryRunOperationError | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| FailedOperation.NotAllowOperation | 禁止该操作。 |
| FailedOperation.StatusInConflict | 当前状态冲突，不能执行该操作。 |
| InternalError.CeleryError | 内部调度系统错误。 |
| InternalError.DatabaseError | 迁移平台数据库访问失败。 |
| InternalError.DuplicateJob | 迁移任务冲突。 |
| InternalError.InternalErrorError | 内部错误。 |
| InternalError.ProtocolError | 通信协议错误。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| LimitExceeded.LimitExceededError | 数量超出限制。 |
| MissingParameter.MissingParameterError | 参数丢失。 |
| OperationDenied.JobOperationDeniedError | 任务操作失败。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
| ResourceInUse.ResourceInUseError | 资源在使用中。 |
| ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
| ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
| ResourceNotFound.JobNotExist | 迁移任务不存在。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
| ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
| UnauthorizedOperation.NotEnoughPrivileges | 认证失败，没有足够权限。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnknownParameter.UnknownParameterError | 未知参数。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |