1. 接口描述
接口请求域名: ckafka.tencentcloudapi.com 。
编辑Datahub连接源
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyConnectResource。 |
Version | 是 | String | 公共参数,本接口取值:2019-08-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResourceId | 是 | String | 连接源的Id 示例值:resource-xxx |
ResourceName | 否 | String | 连接源名称,为空时不修改 示例值:xxx |
Description | 否 | String | 连接源描述,为空时不修改 示例值:xxx |
Type | 否 | String | 连接源类型,修改数据源参数时,需要与原Type相同,否则编辑数据源无效 示例值:xxx |
DtsConnectParam | 否 | DtsModifyConnectParam | Dts配置,Type为DTS时必填 示例值:xxx |
MongoDBConnectParam | 否 | MongoDBModifyConnectParam | MongoDB配置,Type为MONGODB时必填 示例值:xxx |
EsConnectParam | 否 | EsModifyConnectParam | Es配置,Type为ES时必填 示例值:xxx |
ClickHouseConnectParam | 否 | ClickHouseModifyConnectParam | ClickHouse配置,Type为CLICKHOUSE时必填 示例值:xxx |
MySQLConnectParam | 否 | MySQLModifyConnectParam | MySQL配置,Type为MYSQL或TDSQL_C_MYSQL时必填 示例值:xxx |
PostgreSQLConnectParam | 否 | PostgreSQLModifyConnectParam | PostgreSQL配置,Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填 示例值:xxx |
MariaDBConnectParam | 否 | MariaDBModifyConnectParam | MariaDB配置,Type为MARIADB时必填 示例值:xxx |
SQLServerConnectParam | 否 | SQLServerModifyConnectParam | SQLServer配置,Type为SQLSERVER时必填 示例值:xxx |
CtsdbConnectParam | 否 | CtsdbModifyConnectParam | Ctsdb配置,Type为CTSDB 示例值:xxx |
DorisConnectParam | 否 | DorisModifyConnectParam | Doris配置,Type为DORIS 示例值:xxx |
KafkaConnectParam | 否 | KafkaConnectParam | Kafka配置,Type为 KAFKA 时必填 示例值:xxx |
MqttConnectParam | 否 | MqttConnectParam | MQTT配置,Type为 MQTT 时必填 示例值:xxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ConnectResourceResourceIdResp | 连接源的Id 示例值:xxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 编辑Datahub连接源
编辑Datahub连接源
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyConnectResource
<公共请求参数>
{
"Description": "xxx",
"DtsConnectParam": {
"UserName": "xxx",
"Resource": "xxx",
"GroupId": "xxx",
"Password": "xxx",
"Topic": "xxx",
"Port": 0
},
"ResourceName": "xxx",
"ResourceId": "reource-xxx",
"Type": "DTS"
}
输出示例
{
"Response": {
"Result": {
"ResourceId": "resource-xx"
},
"RequestId": "xxx"
}
}
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 | 已存在相同参数。 |