tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StopMigrateJob

Last updated: 2024-12-10 14:45:59

    1. API Description

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

    This API (StopMigrateJob) is used to cancel a data migration task.
    During migration, this API can be used to cancel migration if the task status queried through the DescribeMigrateJobs API is running (status=7) or ready (status=8), and the migration task will fail.

    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: StopMigrateJob.
    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 Canceling a data migration task

    Input Example

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

    Output Example

    {
    "Response": {
        "RequestId": "22f6b9ca-e94d-4a4d-b48f-a5133e791374"
    }
}

    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.StatusInConflict This operation cannot be performed due to a status conflict.
    InternalError.DatabaseError Failed to access the database on the DTS platform.
    InternalError.DuplicateJob Migration tasks are in conflict.
    InternalError.ProtocolError A communication protocol error occurred.
    InternalError.UnknownError An unknown internal error occurred.
    InvalidParameter The parameter is incorrect.
    OperationDenied.JobOperationDeniedError The task operation failed.
    ResourceNotFound.JobNotExist The migration task does not exist.
    UnauthorizedOperation.NotEnoughPrivileges Authentication failed as there were no required permissions.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy