tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ConfigureSubscribeJob

Last updated: 2024-12-04 15:34:49

1. API Description

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

This API is used to configure data subscription instances.

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: ConfigureSubscribeJob.
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.
SubscribeId Yes String Data subscription instance ID
SubscribeMode Yes String Data subscription type. Valid values for non-mongo DatabaseType: all (full instance update); dml (data update); ddl (structure update); dmlAndDdl (data + structure update). Valid values for mongo DatabaseType: all (full instance update); database (subscribe to a table); collection (subscribe to a collection).
AccessType Yes String Source database access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC). Note: The specific optional values depend on the current link support capabilities.
Endpoints.N Yes Array of EndpointItem Database node information
KafkaConfig Yes SubscribeKafkaConfig Kafka configuration
SubscribeObjects.N No Array of SubscribeObject Subscription database table information. When SubscribeMode is not all or ddl, SubscribeObjects is a required parameter.
Protocol No String Subscription data format, such as: protobuf, json, avro. Note: The specific optional values depend on the current link support capabilities. For details on the data format, please refer to the consumption demo documentation on the official website.
PipelineInfo.N No Array of PipelineInfo mongo optional parameter: output aggregation settings.
ExtraAttr.N No Array of KeyValuePairOption Additional information added for the business. The parameter name is called key, and the parameter value is called value.Optional parameters for mysql: ProcessXA. If true is filled in, it will be processed. If it is left blank or filled with other values, it will not be processed.Optional parameters for mongo: SubscribeType. Currently only changeStream is supported. If not filled in, the default is changeStream.Other businesses currently have no optional parameters.

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 Configuring a subscription task

This example shows you how to configure a subscription task of an entire CDB instance, where the data of db1.table1 is delivered to different Kafka partitions based on the ID column value, while the rest of the data is delivered based on the table name.

Input Example

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

{
    "SubscribeMode": "all",
    "SubscribeId": "subs-5ft0e2nrc0",
    "KafkaConfig": {
        "DistributeRules": [
            {
                "DbPattern": "db1",
                "RuleType": "cols",
                "TablePattern": "table1",
                "Columns": [
                    "id"
                ]
            }
        ],
        "NumberOfPartitions": 8,
        "DefaultRuleType": "table"
    },
    "AccessType": "cdb",
    "Protocol": "json",
    "Endpoints": [
        {
            "InstanceId": "cdb-kdxona7h",
            "DatabaseRegion": "ap-guangzhou",
            "EncryptConn": "Encrypted",
            "User": "root",
            "Password": "******"
        }
    ],
    "ExtraAttr": [
        {
            "Value": "true",
            "Key": "ProcessXA"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "abc"
    }
}

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 The CAM signature/authentication information is incorrect.
AuthFailure.AuthFailureError Authentication failed.
FailedOperation Operation failed.
FailedOperation.FailedOperationError The operation failed.
InternalError An internal error occurred.
InternalError.InternalErrorError An internal error occurred.
InternalError.UnknownError An unknown internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.ControllerNotFoundError The current API is not registered due to an exception.
InvalidParameter.InvalidParameterError The parameter is invalid.
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.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
UnsupportedOperation The operation is not supported.
UnsupportedOperation.UnsupportedOperationError The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy