tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateMigrateCheckJob

Last updated: 2023-10-17 11:03:15

    1. API Description

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

    This API is used to verify a migration task.
    Before migration, you should call this API to create a check task. Migration will start only if the check succeeds. You can view the check result through the DescribeMigrationCheckJob API.
    After successful check, if the migration task needs to be modified, a new check task should be created, and migration will start only after the new check succeeds.

    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: CreateMigrateCheckJob.
    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

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a migration check task

    Input Example

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

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

    Output Example

    {
    "Response": {
        "RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385"
    }
}

    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.
    InternalError An internal error occurred.
    InternalError.AddTaskError Failed to create the async task.
    InternalError.CeleryError An internal scheduling system error occurred.
    InternalError.CgwSystemError A CGW 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.LockError Locks are in conflict.
    InternalError.ProtocolError A communication protocol error occurred.
    InternalError.UndefinedError An internal error occurred.
    InternalError.UnknownError An unknown internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameter.InvalidParameterError The parameter is invalid.
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
    MissingParameter.MissingParameterError The parameter is lost.
    OperationDenied The operation was denied.
    OperationDenied.JobOperationDeniedError The task operation failed.
    OperationDenied.OperationDeniedError The operation was denied.
    ResourceInUse.ResourceInUseError The resource is being used.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    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.IntraNetUserNotTaggedError The intranet user did not specify the required tags when creating the migration task. The department, product, and owner tags must be specified.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy