1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查询DIP主题列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDatahubTopics。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SearchWord | 否 | String | 搜索词 示例值：search-test |
| Offset | 否 | Integer | 本次查询的偏移位置，默认为0 示例值：0 |
| Limit | 否 | Integer | 本次返回结果的最大个数，默认为50，最大值为50 示例值：50 |
| QueryFromConnectResource | 否 | Boolean | 是否从连接查询topic列表 示例值：false |
| ConnectResourceId | 否 | String | 连接的ID 示例值：resource-xxx |
| TopicRegularExpression | 否 | String | topic资源表达式 示例值：.* |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeDatahubTopicsResp | 主题列表 示例值：{"TotalCount":1,"TopicList":[{"Name":"appId-test","TopicName":"topic-test","TopicId":"topic-test","PartitionNum":1,"RetentionMs":1,"Note":"note-test","Status":1}]} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Datahub主题列表
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatahubTopics
<公共请求参数>
{}输出示例
{
"Response": {
"RequestId": "136d14bc-109d-4b1a-8b2c-de58cd04536d",
"Result": {
"TopicList": [
{
"Name": "1300957330-devin-topic-test",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-elo4dm34",
"TopicName": "1300957330-devin-topic-test"
},
{
"Name": "1300957330-rxtest",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-2kcw8efy",
"TopicName": "1300957330-rxtest"
},
{
"Name": "1300957330-tanxing-qiang-2nd",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-g1ntq6se",
"TopicName": "1300957330-tanxing-qiang-2nd"
},
{
"Name": "1300957330-test",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-4621aeam",
"TopicName": "1300957330-test"
},
{
"Name": "1300957330-test-1",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-houq8qfw",
"TopicName": "1300957330-test-1"
},
{
"Name": "1300957330-test-topic2",
"Note": "",
"PartitionNum": 2,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-ar3abkmu",
"TopicName": "1300957330-test-topic2"
},
{
"Name": "1300957330-testttt",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-gdbt9w28",
"TopicName": "1300957330-testttt"
},
{
"Name": "1300957330-topic1",
"Note": "",
"PartitionNum": 1,
"RetentionMs": 86400000,
"Status": 1,
"TopicId": "topic-ehzi5lue",
"TopicName": "1300957330-topic1"
}
],
"TotalCount": 8
}
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
