Listing Topics of a Kafka Instance

Function

This API is used to query details about topics of a Kafka instance.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/topics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	String	Parameter description: Instance ID. To obtain it, log in to the Kafka console and find the instance ID on the Kafka instance details page. Constraints: N/A Value range: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Parameter description: Offset, which is the position where the query starts. Constraints: N/A Value range: ≥ 0 Default value: N/A
limit	No	String	Parameter description: Maximum number of instances that can be returned in a query. Constraints: N/A Value range: 1–50 Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Parameter description: Total number of topics. Value range: N/A
size	Integer	Parameter description: Indicates the maximum number of records to be displayed on a page. Value range: N/A
remain_partitions	Integer	Parameter description: Number of remaining partitions. Value range: N/A
max_partitions	Integer	Parameter description: Total number of partitions. Value range: N/A
topic_max_partitions	Integer	Parameter description: Maximum number of partitions in a single topic. Value range: N/A
topics	Array of TopicEntity objects	Parameter description: Topic list.

**Table 4** TopicEntity
Parameter	Type	Description
policiesOnly	Boolean	Parameter description: Whether this policy is the default policy. Value range: true: Yes false: No
name	String	Parameter description: Topic name. Value range: N/A
replication	Integer	Parameter description: Number of replicas, which is configured to ensure data reliability. Value range: N/A
partition	Integer	Parameter description: Number of topic partitions, which is used to set the number of concurrently consumed messages. Value range: N/A
retention_time	Integer	Parameter description: Retention period of a message. Value range: 0–720
sync_replication	Boolean	Parameter description: Whether to enable synchronous replication. This function is disabled by default. Value range: true: Yes. The acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect. false: No.
sync_message_flush	Boolean	Parameter description: Whether synchronous flushing is enabled. The default value is false. Synchronous flushing compromises performance. Value range: true: Yes false: No
external_configs	Object	Parameter description: Extended configuration.
topic_type	Integer	Parameter description: Topic type. Value range: 0: common topic 1: system (internal) topic
topic_other_configs	Array of topic_other_configs objects	Parameter description: Other topic configurations.
topic_desc	String	Parameter description: Topic description. Value range: N/A
created_at	Long	Parameter description: Topic creation time. Value range: N/A

**Table 5** topic_other_configs
Parameter	Type	Description
name	String	Parameter description: Configuration name. Value range: N/A
valid_values	String	Parameter description: Valid value. Value range: N/A
default_value	String	Parameter description: Default value. Value range: N/A
config_type	String	Parameter description: Configuration type. Value range: dynamic static
value	String	Parameter description: Configuration value. Value range: N/A
value_type	String	Parameter description: Configuration value type. Value range: N/A

Example Requests

Querying the topic list

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10

Example Responses

Status code: 200

The query is successful.

{
  "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
}