配置订阅任务

1. 接口描述

接口请求域名： dts.tencentcloudapi.com 。

本接口(ConfigureSubscribeJob)用于配置数据订阅实例。

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

4. 示例

示例1 配置订阅

配置订阅一个cdb整实例的任务，其中db1.table1的数据根据id列值投递到不同的kafka分区，其他的数据根据表名投递

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ConfigureSubscribeJob
<公共请求参数>

{
    "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"
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。