tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

DescribeModifyCheckSyncJobResult

마지막 업데이트 시간:2023-10-17 11:03:09

    1. API Description

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

    This API is used to query the result of the created check task for object modification.

    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: DescribeModifyCheckSyncJobResult.
    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
    Status String Execution status of the check task Valid values: notStarted (Not started), running (Running), failed (Failed), success (Successful).
    StepCount Integer Number of check steps Note: This field may return null, indicating that no valid values can be obtained.
    StepCur Integer Current step Note: This field may return null, indicating that no valid values can be obtained.
    Progress Integer Overall progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
    StepInfos Array of StepInfo Step 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 result of the object modification check task

    This example shows you how to query the result of the object modification check task after the task is created.

    Input Example

    POST / HTTP/1.1Host: dts.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeModifyCheckSyncJobResult<Common request parameters>{    "JobId": "sync-xxsasa"
}

    Output Example

    {
    "Response": {
        "Progress": 100,
        "RequestId": "00ba3080-f61d-11ed-926c-37ede6ab7ad5",
        "Status": "success",
        "StepCount": 15,
        "StepCur": 15,
        "StepInfos": [
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "ConnectDBCheck",
                "StepName": "Database connection check",
                "StepNo": 1,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "OptimizeCheck",
                "StepName": "Peripheral check",
                "StepNo": 2,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "VersionCheck",
                "StepName": "Version check",
                "StepNo": 3,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "SrcPrivilegeCheck",
                "StepName": "Source instance permission check",
                "StepNo": 4,
                "Warnings": [
                    {
                        "Code": "Warning: SrcPrivilegeCheck",
                        "HelpDoc": "",
                        "Message": "The permissions you grant are as follows: GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE, CREATE ROLE, DROP ROLE ON *.* TO `root`@`%` WITH GRANT OPTION,GRANT APPLICATION_PASSWORD_ADMIN,ROLE_ADMIN,SHOW_ROUTINE,XA_RECOVER_ADMIN ON *.* TO `root`@`%` WITH GRANT OPTION. The permission scope of the source instance account is larger than required. DTS won’t use permissions that are not required. You need to grant as few permissions as possible. For more information, visit https://www.tencentcloud.com/document/product/571/58700?from_cn_redirect=1",
                        "SkipInfo": "",
                        "Solution": ""
                    }
                ]
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "SimpleParamCheck",
                "StepName": "Partial instance parameter check",
                "StepNo": 5,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "DstPrivilegeCheck",
                "StepName": "Target instance permission check",
                "StepNo": 6,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "DstEmptyCheck",
                "StepName": "Target instance content conflict check",
                "StepNo": 7,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "DstSpaceCheck",
                "StepName": "Target instance space check",
                "StepNo": 8,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "BinlogParamCheck",
                "StepName": "Binlog parameter check",
                "StepNo": 9,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "ConstraintCheck",
                "StepName": "Foreign key dependency check",
                "StepNo": 10,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "ConstraintRefCheck",
                "StepName": "Partial database/table foreign key dependency check",
                "StepNo": 11,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "ViewCheck",
                "StepName": "View check",
                "StepNo": 12,
                "Warnings": []
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "WarningParamCheck",
                "StepName": "Warning item check",
                "StepNo": 13,
                "Warnings": [
                    {
                        "Code": "Warn: WarningParamCheck",
                        "HelpDoc": "",
                        "Message": "For tables without a primary key nor non-null unique key, there may be a risk of duplicate data. For more information, visit https://www.tencentcloud.com/document/product/571/58739?from_cn_redirect=1",
                        "SkipInfo": "",
                        "Solution": ""
                    }
                ]
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "AdvancedStoreObjectCheck",
                "StepName": "Advanced object check",
                "StepNo": 14,
                "Warnings": [
                    {
                        "Code": "Error: AdvancedStoreObjectCheck",
                        "HelpDoc": "",
                        "Message": "Duplicate table name detected. This may cause views, functions, stored procedures, triggers, and events to work abnormally.",
                        "SkipInfo": "",
                        "Solution": ""
                    }
                ]
            },
            {
                "Errors": [],
                "Progress": 100,
                "StartTime": "",
                "Status": "finished",
                "StepId": "ModifyConfigCheck",
                "StepName": "Configuration modification check",
                "StepNo": 15,
                "Warnings": []
            }
        ]
    }
}

    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
    InvalidParameter.InvalidParameterError The parameter is invalid.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    개인정보 처리방침서비스 약관쿠키 정책