Kafka实例查询Topic
功能介绍
该接口用于查询指定Kafka实例的Topic详情。
URI
GET /v2/{project_id}/instances/{instance_id}/topics
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | String | 参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
| limit | 否 | String | 参数解释: 当次查询返回的最大实例个数。 约束限制: 不涉及。 取值范围: 大于等于0,小于等于200。 默认取值: 50。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: Topic总数。 取值范围: 不涉及。 |
| size | Integer | 参数解释: 分页查询的大小。 取值范围: 不涉及。 |
| remain_partitions | Integer | 参数解释: 剩余分区数。 取值范围: 不涉及。 |
| max_partitions | Integer | 参数解释: 分区总数。 取值范围: 不涉及。 |
| topic_max_partitions | Integer | 参数解释: 单个Topic最大占用分区数。 取值范围: 不涉及。 |
| topics | Array of TopicEntity objects | 参数解释: Topic列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policiesOnly | Boolean | 参数解释: 是否为默认策略。 取值范围:
|
| name | String | 参数解释: Topic名称。 取值范围: 不涉及 |
| replication | Integer | 参数解释: 副本数,配置数据的可靠性。 取值范围: 不涉及 |
| partition | Integer | 参数解释: Topic分区数,设置消费的并发数。 取值范围: 不涉及 |
| retention_time | Integer | 参数解释: 消息老化时间。 取值范围: 0-720 |
| sync_replication | Boolean | 参数解释: 是否开启同步复制,默认关闭。 取值范围:
|
| sync_message_flush | Boolean | 参数解释: 是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 取值范围:
|
| external_configs | Object | 参数解释: 扩展配置。 |
| topic_type | Integer | 参数解释: Topic类型。 取值范围:
|
| topic_other_configs | Array of topic_other_configs objects | 参数解释: Topic其他配置。 |
| topic_desc | String | 参数解释: Topic描述。 取值范围: 不涉及 |
| created_at | Long | 参数解释: Topic创建时间。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 配置名称。 取值范围: 不涉及 |
| valid_values | String | 参数解释: 配置有效值。 取值范围: 不涉及 |
| default_value | String | 参数解释: 配置默认值。 取值范围: 不涉及 |
| config_type | String | 参数解释: 配置类型。 取值范围:
|
| value | String | 参数解释: 配置值。 取值范围: 不涉及 |
| value_type | String | 参数解释: 配置值类型。 取值范围:
|
请求示例
查询Topic列表。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10 响应示例
状态码:200
查询成功。
{
"total" : 1,
"size" : 0,
"topics" : [ {
"policiesOnly" : false,
"name" : "Topic-test01",
"replication" : 3,
"partition" : 3,
"retention_time" : 72,
"sync_replication" : "false",
"sync_message_flush" : "false",
"topic_other_configs" : [ {
"name" : "max.message.bytes",
"valid_values" : "[0...10485760]",
"default_value" : "10485760",
"config_type" : "dynamic",
"value" : "10485760",
"value_type" : "int"
}, {
"name" : "message.timestamp.type",
"valid_values" : "[CreateTime, LogAppendTime]",
"default_value" : "LogAppendTime",
"config_type" : "dynamic",
"value" : "LogAppendTime",
"value_type" : "string"
} ],
"external_configs" : { },
"topic_type" : 0,
"topic_desc" : "This is a test topic",
"created_at" : 1688112779916
} ],
"remain_partitions" : 294,
"max_partitions" : 300,
"topic_max_partitions" : 200
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功。 |
错误码
请参见错误码。