tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SkipSyncCheckItem

Last updated: 2024-12-04 15:33:56

    1. API Description

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

    This API is used for the backend to skip a failed check item. Theoretically, to execute a sync task normally, any check step cannot be skipped, and the check must be passed. For products or links that support check item skipping, see Check Item Overview.

    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: SkipSyncCheckItem.
    Version Yes String Common Params. The value used for this API: 2021-12-06.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    JobId Yes String Task ID, such as "sync-4ddgid2".
    StepIds.N Yes Array of String ID of the check step to be skipped, which is obtained in the StepInfos[i].StepId field returned by the DescribeCheckSyncJobResult API, such as "OptimizeCheck".

    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 Skipping sync check items

    Input Example

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

{
    "JobId": "sync-4ddgid2",
    "StepIds": [
        "OptimizeCheck"
    ]
}

    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.
    FailedOperation Operation failed.
    InternalError An internal error occurred.
    InternalError.DatabaseError Failed to access the database on the DTS platform.
    InternalError.UnknownError An unknown internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    OperationDenied The operation was denied.
    OperationDenied.OperationDeniedError The operation was denied.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy