Подключиться
Yandex Managed Service for Apache Kafka®

Метод list

Получает список топиков Kafka в указанном кластере.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/topics

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить список топиков. Чтобы получить идентификатор кластера, выполните запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "topics": [
    {
      "name": "string",
      "clusterId": "string",
      "partitions": "integer",
      "replicationFactor": "integer",
      "topicConfig_2_1": {
        "cleanupPolicy": "string",
        "compressionType": "string",
        "deleteRetentionMs": "integer",
        "fileDeleteDelayMs": "integer",
        "flushMessages": "integer",
        "flushMs": "integer",
        "minCompactionLagMs": "integer",
        "retentionBytes": "integer",
        "retentionMs": "integer"
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
topics[] object

Топик Kafka. Подробнее читайте в разделе Concepts → Topics and partitions документации.
topics[].
name		 string

Имя топика.
topics[].
clusterId		 string

Идентификатор кластера Apache Kafka®, к которому принадлежит топик.

Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос list.
topics[].
partitions		 integer (int64)

Количество разделов в топике.
topics[].
replicationFactor		 integer (int64)

Количество копий данных (реплик) для топика в кластере.
topics[].
topicConfig_2_1		 object

Настройки топика.
topics[].
topicConfig_2_1.
cleanupPolicy		 string

Политика хранения старых сообщений лога.

  • CLEANUP_POLICY_DELETE: эта политика отбрасывает сегменты лога либо при истечении срока их хранения, либо при достижении предельного размера лога. См. также описание logRetentionMs и других подобных параметров.
  • CLEANUP_POLICY_COMPACT: эта политика сжимает сообщения в логе.
  • CLEANUP_POLICY_COMPACT_AND_DELETE: эта политика использует как сжатие сообщений, так и удаление сегментов лога.
topics[].
topicConfig_2_1.
compressionType		 string

Тип сжатия для указанного топика.

  • COMPRESSION_TYPE_UNCOMPRESSED: не использовать кодек (сообщения не сжимаются).
  • COMPRESSION_TYPE_ZSTD: кодек Zstandard.
  • COMPRESSION_TYPE_LZ4: Кодек LZ4.
  • COMPRESSION_TYPE_SNAPPY: Кодек Snappy.
  • COMPRESSION_TYPE_GZIP: кодек GZip.
  • COMPRESSION_TYPE_PRODUCER: кодек задается на стороне производителя (допустимые кодеки: ZSTD, LZ4, GZIP или SNAPPY).
topics[].
topicConfig_2_1.
deleteRetentionMs		 integer (int64)

Время (в миллисекундах), в течение которого нужно хранить tombstone-маркеры удаления для топиков со сжатым логом.
topics[].
topicConfig_2_1.
fileDeleteDelayMs		 integer (int64)

Время ожидания перед удалением файла из файловой системы.
topics[].
topicConfig_2_1.
flushMessages		 integer (int64)

Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск.

Эта настройка переопределяет на уровне топика настройку уровня кластера logFlushIntervalMessages.
topics[].
topicConfig_2_1.
flushMs		 integer (int64)

Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск.

Эта настройка переопределяет на уровне топика настройку уровня кластера logFlushIntervalMs.
topics[].
topicConfig_2_1.
minCompactionLagMs		 integer (int64)

Минимальное время в миллисекундах, в течение которого сообщение в логе будет оставаться несжатым.
topics[].
topicConfig_2_1.
retentionBytes		 integer (int64)

Максимальный размер, до которого может вырасти раздел, прежде чем Kafka начнет отбрасывать старые сегменты лога, если действует настройка delete cleanupPolicy. Эта настройка полезна, если вам необходимо контролировать размер лога из-за ограниченного дискового пространства.

Эта настройка переопределяет на уровне топика настройку уровня кластера logRetentionBytes.
topics[].
topicConfig_2_1.
retentionMs		 integer (int64)

Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога.

Эта настройка переопределяет на уровне топика настройку уровня кластера logRetentionMs.
nextPageToken string

Токен для получения следующей страницы результатов в ответе.

Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.
В этой статье: