1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查询Datahub连接源
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConnectResource。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ResourceId | 是 | String | 连接源的Id 示例值：resource-test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeConnectResourceResp | 连接源的Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"ResourceId":"resource-test","ResourceName":"resource-test","Description":"description","Type":"","Status":1,"CreateTime":"2019-10-01 00:00:00","ErrorMessage":"","CurrentStep":"WAIT_CREATE_PRIVATELINK","StepList":["WAIT_CREATE_PRIVATELINK","WAIT_CONNECT_PORT","WAIT_CONNECT_RESOURCE"],"MySQLConnectParam":{"Ip":"10.0.0.30","Port":0,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","IsUpdate":true,"ClusterId":"cluster-test","SelfBuilt":true},"PostgreSQLConnectParam":{"Ip":"10.0.0.30","Port":0,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","IsUpdate":true,"ClusterId":"cluster-test","SelfBuilt":true},"DtsConnectParam":{"Ip":"10.0.0.30","Port":9092,"GroupId":"group-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","IsUpdate":true,"Topic":"topic-test","SelfBuilt":true},"MongoDBConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true},"EsConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true},"ClickHouseConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true},"MariaDBConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true},"SQLServerConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true},"CtsdbConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true},"DorisConnectParam":{"Ip":"10.0.0.30","Port":9092,"ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","UserName":"username-test","Password":"password-test","Resource":"resource-test","SelfBuilt":true,"IsUpdate":true,"BePort":13001},"KafkaConnectParam":{"Resource":"resource-test","SelfBuilt":true,"IsUpdate":true,"BrokerAddress":"10.0.0.30","Region":"region-test","NetworkType":"PUBLIC","UniqVpcId":"vpc-test","ServiceVip":"10.0.0.30","Port":13002,"AclEnable":true,"UserName":"username-test","Password":"password-test","Ip":"10.0.0.30","CrossNetResourceUniqueId":"zbpt_perf_kafka","AppId":1000000001},"MqttConnectParam":{"Port":13001,"UserName":"username-test","Password":"password-test","Resource":"resource-test","ServiceVip":"10.0.0.30","UniqVpcId":"vpc-test","SelfBuilt":true,"IsUpdate":true,"Region":"region-test","NetworkType":"PUBLIC","AclEnable":true,"Ip":"10.0.0.30"}} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Datahub连接源
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConnectResource
<公共请求参数>
{
"ResourceId": "reource-test"
}输出示例
{
"Response": {
"Result": {
"ResourceId": "resource-y9v8e3bl",
"ResourceName": "mytest",
"Type": "KAFKA",
"Description": "",
"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
},
"Status": 1,
"CreateTime": "2024-12-04 16:21:08",
"ErrorMessage": "RUNNING",
"CurrentStep": "FINISH",
"StepList": [
"WAIT_CREATE_PRIVATELINK",
"WAIT_CONNECT_PORT",
"WAIT_CONNECT_RESOURCE"
]
},
"RequestId": "4cd38c99-9e9a-4a2d-8641-fa7c4015f764"
}
}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 | 已存在相同参数。 |
