tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCompareReport

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

    1. API Description

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

    This API is used to query the details of a data consistency check task.

    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: DescribeCompareReport.
    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 Migration task ID
    CompareTaskId Yes String Check task ID
    DifferenceLimit No Integer Number of inconsistent objects to be returned
    DifferenceOffset No Integer Offset of inconsistent objects
    DifferenceDB No String Search criterion: Inconsistent database name
    DifferenceTable No String Search criterion: Inconsistent table name
    SkippedLimit No Integer Number of unchecked objects to be returned
    SkippedOffset No Integer Offset of unchecked objects
    SkippedDB No String Search criterion: Unchecked database name
    SkippedTable No String Search criterion: Unchecked table name

    3. Output Parameters

    Parameter Name Type Description
    Abstract CompareAbstractInfo Summary information of data consistency check
    Note: This field may return null, indicating that no valid values can be obtained.
    Detail CompareDetailInfo Data consistency check details
    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 Querying the details of a data consistency check task

    Input Example

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

{
    "JobId": "dts-amm1jw5q",
    "CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk"
}

    Output Example

    {
    "Response": {
        "Abstract": {
            "CheckedTables": 4,
            "Conclusion": "same",
            "DifferentRows": 0,
            "DifferentTables": 0,
            "SkippedTables": 0,
            "Status": "success",
            "TotalTables": 4
        },
        "Detail": {
            "Difference": {
                "Items": [],
                "TotalCount": 0
            },
            "Skipped": {
                "Items": [],
                "TotalCount": 0
            }
        },
        "RequestId": "ac300ff0-00f2-11ed-b005-4930e69d89c2"
    }
}

    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.
    DryRunOperation.DryRunOperationError DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful.
    FailedOperation.FailedOperationError The operation failed.
    InternalError.InternalErrorError An internal error occurred.
    InvalidParameter.InvalidParameterError The parameter is invalid.
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    MissingParameter.MissingParameterError The parameter is lost.
    OperationDenied.OperationDeniedError The operation was denied.
    RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
    ResourceInUse.ResourceInUseError The resource is being used.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    ResourceUnavailable.ResourceUnavailableError The resource is unavailable.
    ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
    UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
    UnknownParameter.UnknownParameterError The parameter is unknown.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy