Updated on 2025-12-08 GMT+08:00

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dms:topic:list

    List

    kafka

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    • dms:instance:get

    -

    topic *

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

String

Definition:

Offset, which is the position where the query starts.

Constraints:

N/A

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–200

Default Value

50

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition:

Total number of topics.

Range:

N/A

size

Integer

Definition:

Indicates the maximum number of records to be displayed on a page.

Range:

N/A

remain_partitions

Integer

Definition:

Number of remaining partitions.

Range:

N/A

max_partitions

Integer

Definition:

Total number of partitions.

Range:

N/A

topic_max_partitions

Integer

Definition:

Maximum number of partitions in a single topic.

Range:

N/A

topics

Array of TopicEntity objects

Definition:

Topic list.

Table 4 TopicEntity

Parameter

Type

Description

policiesOnly

Boolean

Definition:

Whether a policy is default.

Range:

  • true: Yes

  • false: No

name

String

Definition:

Topic name.

Range:

N/A

replication

Integer

Definition:

Number of replicas, which is configured to ensure data reliability.

Range:

N/A

partition

Integer

Definition:

Number of topic partitions, which is used to set the number of concurrently consumed messages.

Range:

N/A

retention_time

Integer

Definition:

Retention period of a message.

Range:

0–720

sync_replication

Boolean

Definition:

Whether to enable synchronous replication. This function is disabled by default.

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

Definition:

Whether synchronous flushing is enabled. The default value is false. Synchronous flushing compromises performance.

Range:

  • true: Yes

  • false: No

external_configs

Object

Definition:

Extended configuration.

topic_type

Integer

Definition:

Topic type.

Range:

  • 0: common topic

  • 1: system (internal) topic

topic_other_configs

Array of topic_other_configs objects

Definition:

Other topic configurations.

topic_desc

String

Definition:

Topic description.

Range:

N/A

created_at

Long

Definition:

Topic creation time.

Range:

N/A

Table 5 topic_other_configs

Parameter

Type

Description

name

String

Definition:

Configuration name.

Range:

N/A

valid_values

String

Definition:

Valid value.

Range:

N/A

default_value

String

Definition:

Default value.

Range:

N/A

config_type

String

Definition:

Configuration type.

Range:

  • dynamic

  • static

value

String

Definition:

Configuration value.

Range:

N/A

value_type

String

Definition

Configuration value type.

Range

  • string

  • integer

  • enum

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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class ListInstanceTopicsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        ListInstanceTopicsRequest request = new ListInstanceTopicsRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListInstanceTopicsResponse response = client.listInstanceTopics(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListInstanceTopicsRequest()
        request.instance_id = "{instance_id}"
        response = client.list_instance_topics(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListInstanceTopicsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListInstanceTopics(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The query is successful.

Error Codes

See Error Codes.