tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateMigrateCheckJob

Last updated: 2024-12-10 14:46:05

    1. API Description

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

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

    For a finance zone link, use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

    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: 2018-03-30.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    JobId Yes String Data migration task ID

    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 Creating a migration check task

    Input Example

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

    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
    FailedOperation.NotAllowOperation This operation is prohibited.
    FailedOperation.ProxyError
    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.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.InvalidIpAddress
    LimitExceeded.MaxUnusedJobs The number of idle migration tasks exceeds the limit.
    OperationDenied The operation was denied.
    OperationDenied.JobOperationDeniedError The task operation failed.
    OperationDenied.OperationDeniedError The operation was denied.
    ResourceNotFound.JobNotExist The migration task does not exist.
    UnauthorizedOperation.NotEnoughPrivileges Authentication failed as there were no required permissions.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy