查询主题详情
更新时间：2023-06-30
该接口用于查询集群中指定主题（topic）的详细信息。
请求结构
GET /v{version}/clusters/{clusterId}/topics/{topicName} HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clusterId | String | 是 | URL参数 | 待查询topic的集群ID |
| topicName | String | 是 | URL参数 | 待查询topic的名称 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| topic | TopicDetail | 返回的主题详情信息 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
| CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
| CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
| CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
| TOPIC_NOT_EXIST | 主题不存在 | 451 | 主题不存在 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/topics/test
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com返回示例
HTTP/1.1 200 OK
x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"topic": {
"topicName": "test",
"partitionNum": 1,
"replicationFactor": 3,
"brokersSkewed": 0.0,
"brokersLeaderSkewed": 0.0,
"brokersSpread": 100.0,
"preferredReplicas": 100.0,
"underReplicated": 0.0,
"otherConfigs": [
{
"key": "cleanup.policy",
"value": "delete",
"unit": null
},
{
"key": "max.message.bytes",
"value": 1048588,
"unit": "bytes"
},
{
"key": "message.timestamp.type",
"value": "CreateTime",
"unit": null
},
{
"key": "min.insync.replicas",
"value": 1,
"unit": null
},
{
"key": "retention.ms",
"value": 48,
"unit": "hour"
},
{
"key": "segment.ms",
"value": 604800000,
"unit": "ms"
}
]
}
}