1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
创建Datahub连接源
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateConnectResource。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ResourceName | 是 | String | 连接源名称 示例值：resource-test |
| Type | 是 | String | 连接源类型 示例值：KAFKA |
| Description | 否 | String | 连接源描述 示例值：description-test |
| DtsConnectParam | 否 | DtsConnectParam | Dts配置，Type为DTS时必填 示例值：{"Resource":"resource-test","Port":8080,"GroupId":"group-test","UserName":"username-test","Password":"password-test","IsUpdate":true,"Topic":"topic-test"} |
| MongoDBConnectParam | 否 | MongoDBConnectParam | MongoDB配置，Type为MONGODB时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","SelfBuilt":false,"IsUpdate":true} |
| EsConnectParam | 否 | EsConnectParam | Es配置，Type为ES时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","SelfBuilt":false,"IsUpdate":true} |
| ClickHouseConnectParam | 否 | ClickHouseConnectParam | ClickHouse配置，Type为CLICKHOUSE时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","SelfBuilt":false,"IsUpdate":true} |
| MySQLConnectParam | 否 | MySQLConnectParam | MySQL配置，Type为MYSQL或TDSQL_C_MYSQL时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","IsUpdate":true,"ClusterId":"cynosdbmysql-test","SelfBuilt":false} |
| PostgreSQLConnectParam | 否 | PostgreSQLConnectParam | PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","ClusterId":"tdcpg-test","IsUpdate":true,"SelfBuilt":false} |
| MariaDBConnectParam | 否 | MariaDBConnectParam | MariaDB配置，Type为MARIADB时必填 示例值：{"Resource":"resource-test","Port":8080,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","IsUpdate":true} |
| SQLServerConnectParam | 否 | SQLServerConnectParam | SQLServer配置，Type为SQLSERVER时必填 示例值：{"Resource":"resource-test","Port":1433,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","IsUpdate":true} |
| DorisConnectParam | 否 | DorisConnectParam | Doris 配置，Type为 DORIS 时必填 示例值：{"Resource":"resource-test","Port":9030,"ServiceVip":"10.0.0.31","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","IsUpdate":true,"SelfBuilt":false,"BePort":8040} |
| KafkaConnectParam | 否 | KafkaConnectParam | Kafka配置，Type为 KAFKA 时必填 示例值：{"Resource":"ckafka-test","SelfBuilt":true,"IsUpdate":true,"BrokerAddress":"10.0.0.30:9092,10.0.0.31:9092","Region":"ap-guangzhou"} |
| MqttConnectParam | 否 | MqttConnectParam | MQTT配置，Type为 MQTT 时必填 示例值：{"UserName":"username-test","Password":"password-test","Resource":"resource-test","UniqVpcId":"vpc-test","SelfBuilt":true,"IsUpdate":true,"Region":"ap-guangzhou"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ConnectResourceResourceIdResp | 连接源的Id 示例值：{"ResourceId":"resource-test"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建Datahub连接源(ES)
创建Datahub连接源(ES)
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConnectResource
<公共请求参数>
{
"Description": "your description",
"EsConnectParam": {
"UserName": "elastic",
"Resource": "es-test",
"Password": "yourpassword",
"Port": 9200,
"ServiceVip": "10.0.0.1",
"UniqVpcId": "vpc-test",
"SelfBuilt": false
},
"ResourceName": "yourresourcename",
"Type": "ES"
}输出示例
{
"Response": {
"Result": {
"ResourceId": "resource-test"
},
"RequestId": "9e6d209b-69fd-4a00-b064-75131aa0a0f8"
}
}示例2 创建Datahub连接源(DTS)
创建Datahub连接源(DTS)
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConnectResource
<公共请求参数>
{
"Description": "your description",
"DtsConnectParam": {
"UserName": "root",
"Resource": "dts-test",
"Topic": "topic",
"GroupId": "group",
"Password": "yourpassword",
"Port": 0
},
"ResourceName": "resourcename",
"Type": "DTS"
}输出示例
{
"Response": {
"Result": {
"ResourceId": "resource-test"
},
"RequestId": "9e6d209b-69fd-4a00-b064-75131aa0a0f8"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.NotAllowedEmpty | 参数不允许为空。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
