tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMigrateCheckJob

Last updated: 2018-09-18 17:00:18
The documentation is not available now.

    1. API Description

    Domain name for API request: dts.tencentcloudapi.com

    This API is used to get the verification result after a verification task is created. The current verification status and progress can be queried via this API. If the verification is successful, call 'StartMigrateJob' to start migration. If it fails, query the failure reason, and modify the migration configuration or change parameters of source/destination instance according to the error message using 'ModifyMigrateJob'.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeMigrateCheckJob
    Version Yes String Common parameter. The value used for this API: 2018-03-30
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    JobId Yes String ID of a data migration task

    3. Output Parameters

    Parameter Name Type Description
    Status String Verification task status: unavailable (unavailable), starting (starting); running (verifying); finished (verification completed)
    ErrorCode Integer Error code of the task
    ErrorMessage String Error message of the task
    Progress String Checks the total progress of the task, for example: "30" means 30%
    CheckFlag Integer Indicates whether the verification is successful or not: 0 - Successful; 1 - Failed; 3 - Not verified
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Error Codes

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

    Error Code Description
    FailedOperation.NotAllowOperation Prohibits the operation.
    InternalError.DatabaseError Access to the database on the migration platform failed.
    InternalError.ProtocolError Communication protocol error.
    InvalidParameter Parameter error
    ResourceNotFound.JobNotExist The migration task does not exist.

    5. Example

    Example 1 Get migration verification result

    Input example

    https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-1kl0iy0v
&<Common request parameters>

    Output example

    {
  "Response": {
    "CheckFlag": 0,
    "ErrorCode": -1,
    "ErrorMessage": "The database table you selected does not exist. Please re-select. [The input parameter table cannot be found in the source instance]",
    "Progress": "100",
    "RequestId": "67b4cfcf-6957-48ae-b7ef-ba33209895e3",
    "Status": "finished"
  }
}

    Example 2 Get migration verification result

    Input example

    https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-dau5czmd
&<Common request parameters>

    Output example

    {
  "Response": {
    "CheckFlag": 1,
    "ErrorCode": 0,
    "ErrorMessage": "ok",
    "Progress": "100",
    "RequestId": "336448b0-2a45-4be4-8356-c245eab5784f",
    "Status": "finished"
  }
}

    6. Other Resources

    Cloud API 3.0 comes with the following development tools to make it easier to call the API.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy