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 | 连接源类型 示例值：KAFKA |
| SearchWord | 否 | String | 连接源名称的关键字查询 示例值：search-test |
| Offset | 否 | Integer | 分页偏移量，默认为0 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100 示例值：20 |
| ResourceRegion | 否 | String | 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源) 示例值：ap-guangzhou |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeConnectResourcesResp | 连接源列表 示例值：{"TotalCount":1,"ConnectResourceList":[{"ResourceId":"resource-test","ResourceName":"resource-test","Description":"description-test","Type":"ES","Status":0,"CreateTime":"2019/8/19 00:00:00","ErrorMessage":"message-test","DatahubTaskCount":1,"CurrentStep":"step-test","TaskProgress":0,"StepList":["step-test"],"EsConnectParam":{"Ip":"10.0.0.3","Port":9200,"ServiceVip":"10.0.0.5","UniqVpcId":"vpc-test","UserName":"user-test","Password":"pwd-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true}}]} |
| 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": "KAFKA",
"SearchWord": "mytest",
"Offset": 0
}输出示例
{
"Response": {
"Result": {
"TotalCount": 1,
"ConnectResourceList": [
{
"ResourceId": "resource-y9v8e3bl",
"ResourceName": "mytest",
"Description": "",
"Status": 1,
"CreateTime": "2024-12-04 16:21:08",
"ErrorMessage": "RUNNING",
"CurrentStep": "FINISH",
"DatahubTaskCount": 0,
"TaskProgress": 36,
"StepList": [
"WAIT_CREATE_PRIVATELINK",
"WAIT_CONNECT_PORT",
"WAIT_CONNECT_RESOURCE"
],
"Type": "KAFKA",
"MongoDBConnectParam": null,
"EsConnectParam": null,
"ClickHouseConnectParam": null,
"DtsConnectParam": null,
"MySQLConnectParam": null,
"MqttConnectParam": null,
"PostgreSQLConnectParam": null,
"MariaDBConnectParam": null,
"SQLServerConnectParam": null,
"CtsdbConnectParam": null,
"DorisConnectParam": null,
"KafkaConnectParam": {
"Region": "ap-guangzhou",
"BrokerAddress": "11.135.14.76:8568",
"SelfBuilt": false,
"Resource": "ckafka-wdvgwwx2",
"IsUpdate": null
}
}
]
},
"RequestId": "21de50a2-3626-4194-a60b-0741e396f368"
}
}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 | 已存在相同参数。 |
