Метод get
Возвращает указанный кластер Apache Kafka®.
Чтобы получить список доступных кластеров Apache Kafka®, выполните запрос list.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера Apache Kafka®. Чтобы получить идентификатор кластера, выполните запрос list. Максимальная длина строки в символах — 50. |
Ответ
HTTP Code: 200 - OK
{
"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"
},
// `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"
},
// конец списка возможных полей`config.kafka`
},
"zookeeper": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"zoneId": [
"string"
],
"brokersCount": "integer",
"assignPublicIp": true
},
"networkId": "string",
"health": "string",
"status": "string"
}
Кластер Apache Kafka. Подробнее читайте в разделе Концепции.
Поле | Описание |
---|---|
id | string Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера. |
folderId | string Идентификатор каталога, которому принадлежит кластер Apache Kafka®. |
createdAt | string (date-time) Время создания. Строка в формате RFC3339. |
name | string Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению |
description | string Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов. |
labels | object Пользовательские метки для кластера Apache Kafka® в виде пар |
environment | string Среда развертывания кластера Apache Kafka®.
|
monitoring[] | object Метаданные системы мониторинга. |
monitoring[]. name |
string Название системы мониторинга. |
monitoring[]. description |
string Описание системы мониторинга. |
monitoring[]. link |
string Ссылка на графики системы мониторинга для кластера Apache Kafka®. |
config | object Конфигурация кластера Apache Kafka®. |
config. version |
string Версия Apache Kafka®, которая используется в кластере. Возможные значения: |
config. kafka |
object Конфигурация и распределение ресурсов для брокеров Kafka. |
config. kafka. resources |
object Вычислительные ресурсы, выделенные брокерам Kafka. |
config. kafka. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
config. kafka. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
config. kafka. resources. diskTypeId |
string Тип хранилища для хоста. |
config. kafka. kafkaConfig_2_1 |
object config.kafka включает только одно из полей kafkaConfig_2_1 , kafkaConfig_2_6 Конфигурация брокера Kafka версии 2.1. |
config. kafka. kafkaConfig_2_1. compressionType |
string Тип сжатия для топиков кластера.
|
config. kafka. kafkaConfig_2_1. logFlushIntervalMessages |
integer (int64) Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск. Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_1. logFlushIntervalMs |
integer (int64) Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_1. logFlushSchedulerIntervalMs |
integer (int64) Частота проверки (в миллисекундах) наличия логов, которые нужно сбросить на диск. Эта проверка выполняется процессом, ответственным за сброс логов. |
config. kafka. kafkaConfig_2_1. logRetentionBytes |
integer (int64) Ограничение размера раздела; Kafka отбросит старые сегменты лога, если , чтобы освободить место, если действует политика Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_1. logRetentionHours |
integer (int64) Количество часов до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. |
config. kafka. kafkaConfig_2_1. logRetentionMinutes |
integer (int64) Количество минут до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки |
config. kafka. kafkaConfig_2_1. logRetentionMs |
integer (int64) Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_6 |
object config.kafka включает только одно из полей kafkaConfig_2_1 , kafkaConfig_2_6 Конфигурация брокера Kafka версии 2.6. |
config. kafka. kafkaConfig_2_6. compressionType |
string Тип сжатия для топиков кластера.
|
config. kafka. kafkaConfig_2_6. logFlushIntervalMessages |
integer (int64) Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск. Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_6. logFlushIntervalMs |
integer (int64) Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_6. logFlushSchedulerIntervalMs |
integer (int64) Частота проверки (в миллисекундах) наличия логов, которые нужно сбросить на диск. Эта проверка выполняется процессом, ответственным за сброс логов. |
config. kafka. kafkaConfig_2_6. logRetentionBytes |
integer (int64) Ограничение размера раздела; Kafka отбросит старые сегменты лога, чтобы освободить место, если действует политика Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. kafka. kafkaConfig_2_6. logRetentionHours |
integer (int64) Количество часов до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. |
config. kafka. kafkaConfig_2_6. logRetentionMinutes |
integer (int64) Количество минут до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки |
config. kafka. kafkaConfig_2_6. logRetentionMs |
integer (int64) Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Если значение не задано, то используется значение настройки Это глобальная настройка, которая задается на уровне кластера. Ее можно переопределить на уровне топика с помощью настройки |
config. zookeeper |
object Конфигурация и распределение ресурсов для хостов ZooKeeper. |
config. zookeeper. resources |
object Вычислительные ресурсы, выделенные хостам ZooKeeper. |
config. zookeeper. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
config. zookeeper. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
config. zookeeper. resources. diskTypeId |
string Тип хранилища для хоста. |
config. zoneId[] |
string Идентификаторы зон доступности, в которых находятся брокеры Kafka. |
config. brokersCount |
integer (int64) Количество брокеров Kafka, развернутых в каждой зоне доступности. |
config. assignPublicIp |
boolean (boolean) Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно |
networkId | string Идентификатор сети, к которой принадлежит кластер. |
health | string Здоровье кластера.
|
status | string Текущее состояние кластера.
|