Listing Topics of a Kafka Instance

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

Definition:

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

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

Definition:

Maximum number of instances that can be returned in a query.

Constraints:

N/A

Range:

≥ 0

Default Value:

N/A

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.

policiesOnly

Boolean

Definition:

Whether a policy is default.

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

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

200

The query is successful.