tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
数据传输服务
    文档
    Download PDF

    CompleteMigrateJob

    最后更新时间：2024-07-24 10:17:34
    下载PDF

      1. API Description

      Domain name for API request: dts.tencentcloudapi.com.

      This API is used to complete a data migration task.
      For tasks in incremental migration mode, you need to call this API before migration gets ready for completion to stop migrating incremental data.
      If the task status queried through the DescribeMigrationJobs API is ready (Status = `readyComplete), you can call this API to complete the migration task.

      A maximum of 20 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: CompleteMigrateJob.
      Version Yes String Common Params. The value used for this API: 2021-12-06.
      Region No String Common Params. This parameter is not required for this API.
      JobId Yes String Data migration task ID
      CompleteMode No String The way to complete the task, which is supported only for legacy MySQL migration tasks. Valid values: waitForSync (wait for the source-replica lag to become 0 before stopping); immediately (complete immediately without waiting for source-replica sync). Default value: waitForSync.

      3. Output Parameters

      Parameter Name Type Description
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Completing a data migration task

      Input Example

      POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CompleteMigrateJob
<Common request parameters>

{
    "JobId": "dts-1kl0iy0v"
}

      Output Example

      {
    "Response": {
        "RequestId": "5268ea15-6636-44d1-89f9-e989d1c82e7d"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      AuthFailure.AuthFailureError Authentication failed.
      DryRunOperation.DryRunOperationError DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful.
      FailedOperation.FailedOperationError The operation failed.
      FailedOperation.NotAllowOperation This operation is prohibited.
      FailedOperation.StatusInConflict This operation cannot be performed due to a status conflict.
      InternalError.CeleryError An internal scheduling system error occurred.
      InternalError.DatabaseError Failed to access the database on the DTS platform.
      InternalError.DuplicateJob Migration tasks are in conflict.
      InternalError.InternalErrorError An internal error occurred.
      InternalError.ProtocolError A communication protocol error occurred.
      InternalError.UnknownError An unknown internal error occurred.
      InvalidParameter The parameter is incorrect.
      InvalidParameter.InvalidParameterError The parameter is invalid.
      InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
      LimitExceeded.LimitExceededError The quantity exceeds the limit.
      MissingParameter.MissingParameterError The parameter is lost.
      OperationDenied.JobOperationDeniedError The task operation failed.
      OperationDenied.OperationDeniedError The operation was denied.
      RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
      ResourceInUse.ResourceInUseError The resource is being used.
      ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
      ResourceNotFound.BizResourceNotFoundError The resource was not found.
      ResourceNotFound.JobNotExist The migration task does not exist.
      ResourceNotFound.ResourceNotFoundError The resource was not found.
      ResourceUnavailable.ResourceUnavailableError The resource is unavailable.
      ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
      UnauthorizedOperation.NotEnoughPrivileges Authentication failed as there were no required permissions.
      UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
      UnknownParameter.UnknownParameterError The parameter is unknown.
      UnsupportedOperation.UnsupportedOperationError The operation is not supported.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款