# Kafka实例查询Topic - ListInstanceTopics #### 功能介绍 该接口用于查询指定Kafka实例的Topic详情。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:topic:list | List | kafka | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:get | - | | dms:topic:list | List | topic \* | - | dms:instance:get | - | #### URI GET /v2/{project_id}/instances/{instance_id}/topics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | String | **参数解释**： 偏移量，表示从此偏移量开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 不涉及。 | | limit | 否 | String | **参数解释**： 当次查询返回的最大实例个数。 **约束限制**： 不涉及。 **取值范围**： 大于等于0，小于等于200。 **默认取值**： 50。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： Topic总数。 **取值范围**： 不涉及。 | | size | Integer | **参数解释**： 分页查询的大小。 **取值范围**： 不涉及。 | | remain_partitions | Integer | **参数解释**： 剩余分区数。 **取值范围**： 不涉及。 | | max_partitions | Integer | **参数解释**： 分区总数。 **取值范围**： 不涉及。 | | topic_max_partitions | Integer | **参数解释**： 单个Topic最大占用分区数。 **取值范围**： 不涉及。 | | topics | Array of [TopicEntity] objects | **参数解释**： Topic列表。 | 表4TopicEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policiesOnly | Boolean | **参数解释**： 是否为默认策略。 **取值范围**： - true：默认策略。 - false：不是默认策略。 | | name | String | **参数解释**： Topic名称。 **取值范围**： 不涉及 | | replication | Integer | **参数解释**： 副本数，配置数据的可靠性。 **取值范围**： 不涉及 | | partition | Integer | **参数解释**： Topic分区数，设置消费的并发数。 **取值范围**： 不涉及 | | retention_time | Integer | **参数解释**： 消息老化时间。 **取值范围**： 0-720 | | sync_replication | Boolean | **参数解释**： 是否开启同步复制，默认关闭。 **取值范围**： - true：开启，客户端生产消息时相应的也要设置acks=-1，否则不生效。 - false：关闭。 | | sync_message_flush | Boolean | **参数解释**： 是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 **取值范围**： - true：同步落盘。 - false：不同步落盘。 | | external_configs | Object | **参数解释**： 扩展配置。 | | topic_type | Integer | **参数解释**： Topic类型。 **取值范围**： - 0：普通Topic。 - 1：系统(内部)Topic。 | | topic_other_configs | Array of [topic_other_configs] objects | **参数解释**： Topic其他配置。 | | topic_desc | String | **参数解释**： Topic描述。 **取值范围**： 不涉及 | | created_at | Long | **参数解释**： Topic创建时间。 **取值范围**： 不涉及 | 表5topic_other_configs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 配置名称。 **取值范围**： 不涉及 | | valid_values | String | **参数解释**： 配置有效值。 **取值范围**： 不涉及 | | default_value | String | **参数解释**： 配置默认值。 **取值范围**： 不涉及 | | config_type | String | **参数解释**： 配置类型。 **取值范围**： - dynamic：动态。 - static：静态。 | | value | String | **参数解释**： 配置值。 **取值范围**： 不涉及 | | value_type | String | **参数解释**： 配置值类型。 **取值范围**： - string：字符串类型。 - integer：整数类型。 - enum：枚举值类型。 | #### 请求示例 查询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" : "integer" }, { "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.ListInstanceTopicsRequest{} request.InstanceId = "{instance_id}" response, err := client.ListInstanceTopics(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=ListInstanceTopics)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。