tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SkipCheckItem

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

    1. API Description

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

    This API is used for the backend to skip a failed check item. Theoretically, to execute a migration 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: SkipCheckItem.
    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
    StepIds.N Yes Array of String ID of the check step to be skipped, which is obtained in the StepInfo[i].StepId field returned by the DescribeMigrationCheckJob API, such as "OptimizeCheck".
    ForeignKeyFlag No String When the check fails due to foreign key dependency, you can use this field to specify whether to migrate the foreign key dependency. The foreign key dependency won’t be migrated when StepIds contains ConstraintCheck and the value of this field is shield, and will be migrated when StepIds contains ConstraintCheck and the value of this field is migrate.

    3. Output Parameters

    Parameter Name Type Description
    Message String Message prompted for skipping the check item
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Skipping a migration check item

    This example shows you how to call this API to skip a failed check item when the check fails or to specify whether to migrate the foreign key dependency.

    Input Example

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

{
    "JobId": "dts-1ewjspuw",
    "StepIds": [
        "OptimizeCheck"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385",
        "Message": "skip item successfully"
    }
}

    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
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    OperationDenied.OperationDeniedError The operation was denied.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy