消息队列 CKafka 版创建连接器实例同步任务-元数据、消息

1. 接口描述

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

连接器实例同步任务-元数据、消息同步

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateMetaAndDataSyncDatahubTask。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
TaskName	是	String	任务名称 64字符内示例值：CreateMetaAndDataSyncDatahubTask
SourceResourceId	是	String	同步源连接参数格式：resource-test 示例值：resource-y9n3a2n6
TargetResourceId	是	String	同步目标连接参数格式：resource-test 示例值：resource-y9n33bb6
Tags.N	否	Array of Tag	标签列表
OffsetType	否	String	Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 枚举值： earliest：最开始位置 latest：最新位置 timestamp：时间点位置示例值：latest
TopicRegularExpression	否	String	正则匹配Topic列表与TopicList参数二选一示例值：^reserved_k2k_ins_sync.*
TopicList.N	否	Array of String	多选topic列表与TopicRegularExpression参数二选一示例值：["bbbb14"]
Prefix	否	String	Topic 前缀示例值：topic1
Separator	否	String	Topic前缀分隔符仅支持 "." / "-" / "_" 示例值：.
Description	否	String	连接器任务描述 128字符内示例值：task1

3. 输出参数

参数名称	类型	描述
Result	CreateDatahubTaskRes	返回结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建连接器-元数据、消息同步任务

输入示例

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

{
    "TaskName": "CreateMetaAndDataSyncDatahubTask",
    "SourceResourceId": "resource-y9n3a2n6",
    "TargetResourceId": "resource-y9n33bb6",
    "OffsetType": "latest",
    "TopicList": [
        "bbbb14"
    ],
    "Prefix": "topic1",
    "Separator": ".",
    "Description": "task1"
}

输出示例

{
    "Response": {
        "Result": {
            "DatahubId": "mock-data-hub-id",
            "TaskId": "task-y9jb79mn"
        },
        "RequestId": "d928539a-f1c8-45c6-ba2c-0bcecfa6e431"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
InvalidParameterValue.NotAllowedEmpty	参数不允许为空。
InvalidParameterValue.RepetitionValue	已存在相同参数。
ResourceNotFound	资源不存在。

创建连接器实例同步任务-元数据、消息数据同步

本页目录：