Метод list
Получает список кластеров Apache Kafka®, принадлежащих указанному каталогу.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters
Query-параметры
Параметр | Описание |
---|---|
folderId | Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров Apache Kafka®. Чтобы получить идентификатор каталога, выполните запрос list. Максимальная длина строки в символах — 50. |
pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | Выражение, позволяющее отфильтровать информацию о ресурсах в ответе, оставив только нужную. В этом выражении должны быть указаны: 1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю Cluster.name. 2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений. 3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-zA-Z0-9_-]+$ . Пример фильтра: name NOT IN 'test,beta' . Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"clusters": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"kafka": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
// `clusters[].config.kafka` включает только одно из полей `kafkaConfig_2_1`, `kafkaConfig_2_6`
"kafkaConfig_2_1": {
"compressionType": "string",
"logFlushIntervalMessages": "integer",
"logFlushIntervalMs": "integer",
"logFlushSchedulerIntervalMs": "integer",
"logRetentionBytes": "integer",
"logRetentionHours": "integer",
"logRetentionMinutes": "integer",
"logRetentionMs": "integer"
},
"kafkaConfig_2_6": {
"compressionType": "string",
"logFlushIntervalMessages": "integer",
"logFlushIntervalMs": "integer",
"logFlushSchedulerIntervalMs": "integer",
"logRetentionBytes": "integer",
"logRetentionHours": "integer",
"logRetentionMinutes": "integer",
"logRetentionMs": "integer"
},
// конец списка возможных полей`clusters[].config.kafka`
},
"zookeeper": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"zoneId": [
"string"
],
"brokersCount": "integer",
"assignPublicIp": true
},
"networkId": "string",
"health": "string",
"status": "string"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
clusters[] | object Кластер Apache Kafka. Подробнее читайте в разделе Концепции. |
clusters[]. id |
string Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера. |
clusters[]. folderId |
string Идентификатор каталога, которому принадлежит кластер Apache Kafka®. |
clusters[]. createdAt |
string (date-time) Время создания. Строка в формате RFC3339. |
clusters[]. name |
string Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению |
clusters[]. description |
string Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов. |
clusters[]. labels |
object Пользовательские метки для кластера Apache Kafka® в виде пар |
clusters[]. environment |
string Среда развертывания кластера Apache Kafka®.
|
clusters[]. monitoring[] |
object Метаданные системы мониторинга. |
clusters[]. monitoring[]. name |
string Название системы мониторинга. |
clusters[]. monitoring[]. description |
string Описание системы мониторинга. |
clusters[]. monitoring[]. link |
string Ссылка на графики системы мониторинга для кластера Apache Kafka®. |
clusters[]. config |
object Конфигурация кластера Apache Kafka®. |
clusters[]. config. version |
string Версия Apache Kafka®, которая используется в кластере. Возможные значения: |
clusters[]. config. kafka |
object Конфигурация и распределение ресурсов для брокеров Kafka. |
clusters[]. config. kafka. resources |
object Вычислительные ресурсы, выделенные брокерам Kafka. |
clusters[]. config. kafka. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
clusters[]. config. kafka. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
clusters[]. config. kafka. resources. diskTypeId |
string Тип хранилища для хоста. |
clusters[]. config. kafka. kafkaConfig_2_1 |
object clusters[].config.kafka включает только одно из полей kafkaConfig_2_1 , kafkaConfig_2_6 Конфигурация брокера Kafka версии 2.1. |
clusters[]. config. kafka. kafkaConfig_2_1. compressionType |
string Тип сжатия для топиков кластера.
|
clusters[]. config. kafka. kafkaConfig_2_1. logFlushIntervalMessages |
integer (int64) Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск. Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_1. logFlushIntervalMs |
integer (int64) Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_1. logFlushSchedulerIntervalMs |
integer (int64) Частота проверки (в миллисекундах) наличия логов, которые нужно сбросить на диск. Эта проверка выполняется процессом, ответственным за сброс логов. |
clusters[]. config. kafka. kafkaConfig_2_1. logRetentionBytes |
integer (int64) Ограничение размера раздела; Kafka отбросит старые сегменты лога, если , чтобы освободить место, если действует политика Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_1. logRetentionHours |
integer (int64) Количество часов до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. |
clusters[]. config. kafka. kafkaConfig_2_1. logRetentionMinutes |
integer (int64) Количество минут до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки |
clusters[]. config. kafka. kafkaConfig_2_1. logRetentionMs |
integer (int64) Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_6 |
object clusters[].config.kafka включает только одно из полей kafkaConfig_2_1 , kafkaConfig_2_6 Конфигурация брокера Kafka версии 2.6. |
clusters[]. config. kafka. kafkaConfig_2_6. compressionType |
string Тип сжатия для топиков кластера.
|
clusters[]. config. kafka. kafkaConfig_2_6. logFlushIntervalMessages |
integer (int64) Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск. Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_6. logFlushIntervalMs |
integer (int64) Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_6. logFlushSchedulerIntervalMs |
integer (int64) Частота проверки (в миллисекундах) наличия логов, которые нужно сбросить на диск. Эта проверка выполняется процессом, ответственным за сброс логов. |
clusters[]. config. kafka. kafkaConfig_2_6. logRetentionBytes |
integer (int64) Ограничение размера раздела; Kafka отбросит старые сегменты лога, чтобы освободить место, если действует политика Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. kafka. kafkaConfig_2_6. logRetentionHours |
integer (int64) Количество часов до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. |
clusters[]. config. kafka. kafkaConfig_2_6. logRetentionMinutes |
integer (int64) Количество минут до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки |
clusters[]. config. kafka. kafkaConfig_2_6. logRetentionMs |
integer (int64) Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
clusters[]. config. zookeeper |
object Конфигурация и распределение ресурсов для хостов ZooKeeper. |
clusters[]. config. zookeeper. resources |
object Вычислительные ресурсы, выделенные хостам ZooKeeper. |
clusters[]. config. zookeeper. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
clusters[]. config. zookeeper. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
clusters[]. config. zookeeper. resources. diskTypeId |
string Тип хранилища для хоста. |
clusters[]. config. zoneId[] |
string Идентификаторы зон доступности, в которых находятся брокеры Kafka. |
clusters[]. config. brokersCount |
integer (int64) Количество брокеров Kafka, развернутых в каждой зоне доступности. |
clusters[]. config. assignPublicIp |
boolean (boolean) Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно |
clusters[]. networkId |
string Идентификатор сети, к которой принадлежит кластер. |
clusters[]. health |
string Здоровье кластера.
|
clusters[]. status |
string Текущее состояние кластера.
|
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |