tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StopSyncJob

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

    1. API Description

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

    This API is used to stop a sync task. After calling this API, you can call the DescribeSyncJobs API to query the latest task status.

    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: StopSyncJob.
    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 Sync 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 Stopping a sync task

    Input Example

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

{
    "JobId": "sync-7r1cz016"
}

    Output Example

    {
    "Response": {
        "RequestId": "ead9fdc1-baa8-4a09-aaa1-c2012690c976"
    }
}

    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
    InternalError.UnknownError An unknown internal error occurred.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy