tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifySyncJobConfig

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

    1. API Description

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

    This API is used to modify the configuration of a data sync task after the task is started.\n Configuration modification steps: Modify sync task configuration -> Create a modification check task -> Query the check task result -> Start the configuration modification 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: ModifySyncJobConfig.
    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
    DynamicObjects No Objects The modified sync objects
    DynamicOptions No DynamicOptions The modified sync task options

    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 Configuring an object modification task

    This example shows you how to start an object modification task as needed.

    Input Example

    POST / HTTP/1.1Host: dts.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifySyncJobConfig<Common request parameters>{    "JobId": "sync-4t8k7e8t",    "DynamicObjects": {        "Mode": "Partial",        "Databases": [            {                "DbName": "db1",                "DbMode": "All",                "TableMode": "All",                "ViewMode": "All"            }        ]    },    "DynamicOptions": {        "ConflictHandleOption": {},        "ConflictHandleType": "ReportError",        "DdlOptions": [            {                "DdlObject": "Database",                "DdlValue": []            },            {                "DdlObject": "Table",                "DdlValue": []            },            {                "DdlObject": "View",                "DdlValue": []            },            {                "DdlObject": "Index",                "DdlValue": []            }        ],        "OpTypes": [            "Insert",            "Update",            "Delete",            "DDL"        ]    }}

    Output Example

    {
    "Response": {
        "RequestId": "xxxaasassas"
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy