# List Kafka cluster topics - ListUKafkaTopics

## Overview

Get Kafka instance topic list information.The instance ID can be obtained through the `ClusterSet.ClusterInstanceId` method of the `ListUKafkaInstance` interface.






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUKafkaTopics`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the [GetProjectList Interface](/docs/api/summary/get_project_list). |No|
| **ClusterInstanceId** | string | The instance ID can be obtained through the `ClusterSet.ClusterInstanceId` method of the `ListUKafkaInstance` interface. |**Yes**|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **TopicList** | array[[*TopicInfo*](#topicinfo)] | Topic Information List |**Yes**|
| **Length** | int | topic List Length |No|

#### Data Model


#### TopicInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Topic** | string | topic name |No|
| **NumOfPartition** | int | Number of Partitions |No|
| **NumOfOccupyBroker** | int | Number of brokers occupied |No|
| **NumOfReplica** | int | Number of Replicas |No|
| **UnderReplicasPer** | float | Lagging Replica Proportion |No|
| **Status** | string | topic status |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=ListUKafkaTopics
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=CYpWEvIo
&ClusterInstanceId=TKmEvKSR
```

### Response Example
    
```json
{
  "Action": "ListUKafkaTopicsResponse",
  "Length": 5,
  "RetCode": 0,
  "TopicList": [
    {
      "NumOfOccupyBroker": 2,
      "NumOfPartition": 1,
      "NumOfReplica": 4,
      "Status": "NONE|INIT|DOING",
      "Topic": "xlqURVbE",
      "UnderReplicasPer": 5.63136
    }
  ]
}
```