1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查询Datahub连接源列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConnectResources。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 否 | String | 连接源类型 示例值：xxx |
| SearchWord | 否 | String | 连接源名称的关键字查询 示例值：xxx |
| Offset | 否 | Integer | 分页偏移量，默认为0 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100 示例值：20 |
| ResourceRegion | 否 | String | 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源) 示例值：ap-guangzhou |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeConnectResourcesResp | 连接源列表 示例值：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: DescribeConnectResources
<公共请求参数>
{
"Limit": 0,
"Type": "xxx",
"SearchWord": "xxx",
"Offset": 0
}输出示例
{
"Response": {
"Result": {
"TotalCount": 0,
"ConnectResourceList": [
{
"ResourceId": "abc",
"ResourceName": "abc",
"Description": "abc",
"Type": "abc",
"Status": 0,
"CreateTime": "abc",
"ErrorMessage": "abc",
"DatahubTaskCount": 0,
"CurrentStep": "abc",
"TaskProgress": 0,
"StepList": [
"abc"
],
"DtsConnectParam": {
"Port": 0,
"GroupId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"IsUpdate": true,
"Topic": "abc"
},
"MongoDBConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"SelfBuilt": true,
"IsUpdate": true
},
"EsConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"SelfBuilt": true,
"IsUpdate": true
},
"ClickHouseConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"SelfBuilt": true,
"IsUpdate": true
},
"MySQLConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"IsUpdate": true,
"ClusterId": "abc",
"SelfBuilt": true
},
"PostgreSQLConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"ClusterId": "abc",
"IsUpdate": true,
"SelfBuilt": true
},
"MariaDBConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"IsUpdate": true
},
"SQLServerConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"IsUpdate": true
},
"CtsdbConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc"
},
"DorisConnectParam": {
"Port": 0,
"ServiceVip": "abc",
"UniqVpcId": "abc",
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"IsUpdate": true,
"SelfBuilt": true,
"BePort": 0
},
"KafkaConnectParam": {
"Resource": "abc",
"SelfBuilt": true,
"IsUpdate": true,
"BrokerAddress": "abc",
"Region": "abc"
},
"MqttConnectParam": {
"UserName": "abc",
"Password": "abc",
"Resource": "abc",
"UniqVpcId": "abc",
"SelfBuilt": true,
"IsUpdate": true,
"Region": "abc"
}
}
]
},
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.NotAllowedEmpty | 参数不允许为空。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
