Работа с топиками и разделами
В кластере Managed Service for Apache Kafka® вы можете:
- Создать топик и разделы для него.
- Изменить настройки топика и его разделов.
- Удалить топик.
- Получить список топиков в кластере.
- Получить детальную информацию о топике.
Создать топик
Чтобы создать топик, выполните следующие действия:
- Перейдите на страницу каталога и выберите сервис Managed Service for Apache Kafka®.
- Нажмите на имя нужного кластера и перейдите на вкладку Топики.
- Нажмите кнопку Создать топик.
- В блоке Базовые параметры задайте базовые параметры топика:
- Имя топика (должно быть уникально в пределах кластера Apache Kafka®).
- Количество разделов в топике.
- Фактор репликации. Значение этого параметра не должно превышать количество брокеров в кластере. Минимальное значение:
1
. Значение по умолчанию:- для кластера из одного или двух брокеров:
1
; - для кластера с тремя и более брокерами:
3
.
- для кластера из одного или двух брокеров:
- В блоке Настройки топика задайте настройки топика.
- Нажмите кнопку Создать.
Если у вас еще нет интерфейса командной строки Yandex.Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы создать топик:
-
Посмотрите описание команды CLI для создания топиков:
yc managed-kafka topic create --help
-
Создайте топик:
yc managed-kafka topic create <имя топика> \ --cluster-name <имя кластера> \ --partitions <количество разделов> \ --replication-factor <фактор репликации>
При необходимости здесь же задайте настройки топика.
Воспользуйтесь методом API create и передайте в запросе:
- Идентификатор кластера, в котором нужно создать топик, в параметре
clusterId
. Чтобы узнать идентификатор, получите список кластеров в каталоге. - Настройки топика в параметре
topicSpec
.
Изменить настройки топика
Важно
Количество разделов в топике Apache Kafka® допустимо изменять только в сторону увеличения.
Чтобы изменить настройки топика, выполните следующие действия:
- Перейдите на страницу каталога и выберите сервис Managed Service for Apache Kafka®.
- Нажмите на имя нужного кластера, затем выберите вкладку Топики.
- Нажмите значок для нужного топика и выберите пункт Редактировать.
- Измените базовые параметры топика:
- Количество разделов в топике.
- Фактор репликации. Значение этого параметра не должно превышать количество брокеров в кластере. Минимальное значение:
1
. Значение по умолчанию:- для кластера из одного или двух брокеров:
1
; - для кластера с тремя и более брокерами:
3
.
- для кластера из одного или двух брокеров:
- Измените дополнительные настройки топика.
- Нажмите кнопку Сохранить.
Если у вас еще нет интерфейса командной строки Yandex.Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы изменить настройки топика:
-
Посмотрите описание команды CLI для изменения топиков:
yc managed-kafka topic update --help
-
Измените настройки топика:
yc managed-kafka topic update <имя топика> \ --cluster-name <имя кластера> \ --partitions <количество разделов> \ --replication-factor <фактор репликации>
Воспользуйтесь методом API update и передайте в запросе:
- Идентификатор кластера, в котором находится топик, в параметре
clusterId
. Чтобы узнать идентификатор, получите список кластеров в каталоге. - Имя топика в параметре
topicName
. Чтобы узнать имя, получите список топиков в кластере. - Список настроек, которые необходимо изменить, в параметре
updateMask
(одной строкой через запятую). Если не задать этот параметр, метод API сбросит на значения по умолчанию все настройки топика, которые не были явно указаны в запросе. - Новые значения настроек топика в параметре
topicSpec
.
Удалить топик
Примечание
Выданные учетной записи права на доступ к топику сохраняются даже после удаления топика. Вы можете либо отозвать эти права доступа, либо оставить. В последнем случае вы можете создать топик с тем же именем и работать с ним без переназначения прав учетной записи.
Чтобы удалить топик, выполните следующие действия:
- Перейдите на страницу каталога и выберите сервис Managed Service for Apache Kafka®.
- Нажмите на имя нужного кластера и перейдите на вкладку Топики.
- Нажмите значок для нужного топика и выберите пункт Удалить топик.
- Подтвердите удаление топика и нажмите кнопку Удалить.
Если у вас еще нет интерфейса командной строки Yandex.Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы удалить топик:
-
Посмотрите описание команды CLI для изменения топиков:
yc managed-kafka topic delete --help
-
Удалите топик:
yc managed-kafka topic delete <имя топика> --cluster-name <имя кластера>
Воспользуйтесь методом API delete и передайте в запросе:
- Идентификатор кластера, в котором находится топик, в параметре
clusterId
. Чтобы узнать идентификатор, получите список кластеров в каталоге. - Имя топика в параметре
topicName
. Чтобы узнать имя, получите список топиков в кластере.
Получить список топиков в кластере
Чтобы получить список топиков, выполните следующие действия:
- Перейдите на страницу каталога и выберите сервис Managed Service for Apache Kafka®.
- Нажмите на имя нужного кластера и перейдите на вкладку Топики.
Если у вас еще нет интерфейса командной строки Yandex.Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы получить список топиков, выполните следующую команду:
yc managed-kafka topic list --cluster-name <имя кластера>
Воспользуйтесь методом API list: передайте значение идентификатора требуемого кластера в параметре clusterId
запроса.
Чтобы узнать идентификатор кластера, получите список кластеров в каталоге.
Получить детальную информацию о топике
Чтобы получить детальную информацию о топике, выполните следующие действия:
- Перейдите на страницу каталога и выберите сервис Managed Service for Apache Kafka®.
- Нажмите на имя нужного кластера и перейдите на вкладку Топики.
- Нажмите на имя нужного топика.
Если у вас еще нет интерфейса командной строки Yandex.Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы получить детальную информацию о топике, выполните следующую команду:
yc managed-kafka topic get <имя топика> --cluster-name <имя кластера>
Чтобы получить детальную информацию о топике, воспользуйтесь методом API get и передайте в запросе:
- Идентификатор кластера, в котором находится топик, в параметре
clusterId
. Чтобы узнать идентификатор, получите список кластеров в каталоге. - Имя топика в параметре
topicName
. Чтобы узнать имя, получите список топиков в кластере.