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

ClusterService

Набор методов для управления кластерами Apache Kafka®.

Вызов Описание
Get Возвращает указанный кластер Apache Kafka®.
List Получает список кластеров Apache Kafka®, принадлежащих указанному каталогу.
Create Создает новый кластер Apache Kafka® в указанном каталоге.
Update Изменяет указанный кластер Apache Kafka®.
Delete Удаляет указанный кластер Apache Kafka®.
Move Перемещает кластер Apache Kafka® в указанный каталог.
Start Запускает указанный кластер Apache Kafka®.
Stop Останавливает указанный кластер Apache Kafka®.
ListLogs Получает логи для указанного кластера Apache Kafka®.
StreamLogs То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов.
ListOperations Получает список операций для указанного кластера Apache Kafka®.
ListHosts Получает список хостов для указанного кластера Apache Kafka®.

Вызовы ClusterService

Get

Возвращает указанный кластер Apache Kafka®.
Чтобы получить список доступных кластеров Apache Kafka®, выполните запрос List.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

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

Cluster

Поле Описание
id string
Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
folder_id string
Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
description string
Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
environment enum Environment
Среда развертывания кластера Apache Kafka®.
  • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
    monitoring[] Monitoring
    Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
    config ConfigSpec
    Конфигурация кластера Apache Kafka®.
    network_id string
    Идентификатор сети, к которой принадлежит кластер.
    health enum Health
    Здоровье кластера.
    • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
    • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
    • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
    • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
      status enum Status
      Текущее состояние кластера.
      • STATUS_UNKNOWN: Состояние кластера неизвестно.
      • CREATING: Кластер создается.
      • RUNNING: Кластер работает нормально.
      • ERROR: В кластере произошла ошибка, блокирующая работу.
      • UPDATING: Кластер изменяется.
      • STOPPING: Кластер останавливается.
      • STOPPED: Кластер остановлен.
      • STARTING: Кластер запускается.

        Monitoring

        Поле Описание
        name string
        Название системы мониторинга.
        description string
        Описание системы мониторинга.
        link string
        Ссылка на графики системы мониторинга для кластера Apache Kafka®.

        ConfigSpec

        Поле Описание
        version string
        Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
        kafka Kafka
        Конфигурация и распределение ресурсов для брокеров Kafka.
        zookeeper Zookeeper
        Конфигурация и распределение ресурсов для хостов ZooKeeper.
        zone_id[] string
        Идентификаторы зон доступности, в которых находятся брокеры Kafka.
        brokers_count google.protobuf.Int64Value
        Количество брокеров Kafka, развернутых в каждой зоне доступности.
        assign_public_ip bool
        Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

        Kafka

        Поле Описание
        resources Resources
        Вычислительные ресурсы, выделенные брокерам Kafka.
        kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
        Конфигурация брокера Kafka.
          kafka_config_2_1 KafkaConfig2_1
        Конфигурация брокера Kafka.
          kafka_config_2_6 KafkaConfig2_6
        Конфигурация брокера Kafka.

        Zookeeper

        Поле Описание
        resources Resources
        Вычислительные ресурсы, выделенные хостам ZooKeeper.

        List

        Получает список кластеров Apache Kafka®, принадлежащих указанному каталогу.

        rpc List (ListClustersRequest) returns (ListClustersResponse)

        ListClustersRequest

        Поле Описание
        folder_id string
        Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров Apache Kafka®.
        Чтобы получить идентификатор каталога, выполните запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
        page_size int64
        Максимальное количество результатов на одной странице в ответе.
        Если количество результатов больше чем page_size, сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
        page_token string
        Токен страницы.
        Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
        filter string
        1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю Cluster.name.
        2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений.
        3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-zA-Z0-9_-]+$.
        Максимальная длина строки в символах — 1000.

        ListClustersResponse

        Поле Описание
        clusters[] Cluster
        Список кластеров Apache Kafka®.
        next_page_token string
        Токен для получения следующей страницы результатов в ответе.
        Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

        Cluster

        Поле Описание
        id string
        Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
        folder_id string
        Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
        created_at google.protobuf.Timestamp
        Время создания.
        name string
        Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
        description string
        Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
        labels map<string,string>
        Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
        environment enum Environment
        Среда развертывания кластера Apache Kafka®.
        • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
        • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
          monitoring[] Monitoring
          Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
          config ConfigSpec
          Конфигурация кластера Apache Kafka®.
          network_id string
          Идентификатор сети, к которой принадлежит кластер.
          health enum Health
          Здоровье кластера.
          • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
          • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
          • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
          • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
            status enum Status
            Текущее состояние кластера.
            • STATUS_UNKNOWN: Состояние кластера неизвестно.
            • CREATING: Кластер создается.
            • RUNNING: Кластер работает нормально.
            • ERROR: В кластере произошла ошибка, блокирующая работу.
            • UPDATING: Кластер изменяется.
            • STOPPING: Кластер останавливается.
            • STOPPED: Кластер остановлен.
            • STARTING: Кластер запускается.

              Monitoring

              Поле Описание
              name string
              Название системы мониторинга.
              description string
              Описание системы мониторинга.
              link string
              Ссылка на графики системы мониторинга для кластера Apache Kafka®.

              ConfigSpec

              Поле Описание
              version string
              Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
              kafka Kafka
              Конфигурация и распределение ресурсов для брокеров Kafka.
              zookeeper Zookeeper
              Конфигурация и распределение ресурсов для хостов ZooKeeper.
              zone_id[] string
              Идентификаторы зон доступности, в которых находятся брокеры Kafka.
              brokers_count google.protobuf.Int64Value
              Количество брокеров Kafka, развернутых в каждой зоне доступности.
              assign_public_ip bool
              Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

              Kafka

              Поле Описание
              resources Resources
              Вычислительные ресурсы, выделенные брокерам Kafka.
              kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
              Конфигурация брокера Kafka.
                kafka_config_2_1 KafkaConfig2_1
              Конфигурация брокера Kafka.
                kafka_config_2_6 KafkaConfig2_6
              Конфигурация брокера Kafka.

              Zookeeper

              Поле Описание
              resources Resources
              Вычислительные ресурсы, выделенные хостам ZooKeeper.

              Create

              Создает новый кластер Apache Kafka® в указанном каталоге.

              rpc Create (CreateClusterRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:CreateClusterMetadata

                  Operation.response:Cluster

              CreateClusterRequest

              Поле Описание
              folder_id string
              Обязательное поле. Идентификатор каталога, в котором будет создан кластер Apache Kafka®.
              Чтобы получить идентификатор каталога, выполните запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
              name string
              Обязательное поле. Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
              description string
              Описание кластера Apache Kafka®. Максимальная длина строки в символах — 256.
              labels map<string,string>
              Пользовательские метки для кластера Apache Kafka® в виде пар key:value.
              Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_./\\@0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_./\\@0-9a-z]*.
              environment Cluster.Environment
              Среда развертывания кластера Apache Kafka®.
              config_spec ConfigSpec
              Конфигурация Kafka и хостов в кластере Apache Kafka®.
              topic_specs[] TopicSpec
              Одна или несколько конфигураций топиков, создаваемых в кластере Apache Kafka®.
              user_specs[] UserSpec
              Конфигурации учетных записей, создаваемых в кластере Apache Kafka®.
              network_id string
              Идентификатор сети, в которой будет создан кластер Apache Kafka®. Максимальная длина строки в символах — 50.

              ConfigSpec

              Поле Описание
              version string
              Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
              kafka Kafka
              Конфигурация и распределение ресурсов для брокеров Kafka.
              zookeeper Zookeeper
              Конфигурация и распределение ресурсов для хостов ZooKeeper.
              zone_id[] string
              Идентификаторы зон доступности, в которых находятся брокеры Kafka.
              brokers_count google.protobuf.Int64Value
              Количество брокеров Kafka, развернутых в каждой зоне доступности.
              assign_public_ip bool
              Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

              Kafka

              Поле Описание
              resources Resources
              Вычислительные ресурсы, выделенные брокерам Kafka.
              kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
              Конфигурация брокера Kafka.
                kafka_config_2_1 KafkaConfig2_1
              Конфигурация брокера Kafka.
                kafka_config_2_6 KafkaConfig2_6
              Конфигурация брокера Kafka.

              Zookeeper

              Поле Описание
              resources Resources
              Вычислительные ресурсы, выделенные хостам ZooKeeper.

              TopicSpec

              Поле Описание
              name string
              Имя топика.
              partitions google.protobuf.Int64Value
              Количество разделов в топике.
              replication_factor google.protobuf.Int64Value
              Количество копий данных топика, хранящихся в кластере.
              topic_config oneof: topic_config_2_1
              Пользовательские настройки топика.
                topic_config_2_1 TopicConfig2_1
              Пользовательские настройки топика.

              TopicConfig2_1

              Поле Описание
              cleanup_policy enum CleanupPolicy
              Политика хранения старых сообщений лога.
              • CLEANUP_POLICY_DELETE: эта политика отбрасывает сегменты лога либо при истечении срока их хранения, либо при достижении предельного размера лога. См. также описание KafkaConfig2_1.log_retention_ms и других подобных параметров.
              • CLEANUP_POLICY_COMPACT: эта политика сжимает сообщения в логе.
              • CLEANUP_POLICY_COMPACT_AND_DELETE: эта политика использует как сжатие сообщений, так и удаление сегментов лога.
                compression_type enum CompressionType
                Тип сжатия для указанного топика.
                • 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).
                  delete_retention_ms google.protobuf.Int64Value
                  Время (в миллисекундах), в течение которого нужно хранить tombstone-маркеры удаления для топиков со сжатым логом.
                  file_delete_delay_ms google.protobuf.Int64Value
                  Время ожидания перед удалением файла из файловой системы.
                  flush_messages google.protobuf.Int64Value
                  Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск.
                  Эта настройка переопределяет на уровне топика настройку уровня кластера KafkaConfig2_1.log_flush_interval_messages.
                  flush_ms google.protobuf.Int64Value
                  Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск.
                  Эта настройка переопределяет на уровне топика настройку уровня кластера KafkaConfig2_1.log_flush_interval_ms.
                  min_compaction_lag_ms google.protobuf.Int64Value
                  Минимальное время в миллисекундах, в течение которого сообщение в логе будет оставаться несжатым.
                  retention_bytes google.protobuf.Int64Value
                  Максимальный размер, до которого может вырасти раздел, прежде чем Kafka начнет отбрасывать старые сегменты лога, если действует настройка delete cleanup_policy. Эта настройка полезна, если вам необходимо контролировать размер лога из-за ограниченного дискового пространства.
                  Эта настройка переопределяет на уровне топика настройку уровня кластера KafkaConfig2_1.log_retention_bytes.
                  retention_ms google.protobuf.Int64Value
                  Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога.
                  Эта настройка переопределяет на уровне топика настройку уровня кластера KafkaConfig2_1.log_retention_ms.

                  UserSpec

                  Поле Описание
                  name string
                  Обязательное поле. Имя пользователя Kafka. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
                  password string
                  Обязательное поле. Пароль пользователя Kafka. Длина строки в символах должна быть от 8 до 128.
                  permissions[] Permission
                  Набор разрешений, предоставленных пользователю.

                  Permission

                  Поле Описание
                  topic_name string
                  Имя топика, к которому предоставляется доступ.
                  Чтобы получить имя топика, выполните запрос TopicService.List.
                  role enum AccessRole
                  Роль доступа, которую нужно предоставить пользователю.
                  • ACCESS_ROLE_PRODUCER: роль пользователя — производитель.
                  • ACCESS_ROLE_CONSUMER: роль пользователя — потребитель.

                    Operation

                    Поле Описание
                    id string
                    Идентификатор операции.
                    description string
                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                    created_at google.protobuf.Timestamp
                    Время создания ресурса в формате в RFC3339.
                    created_by string
                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                    modified_at google.protobuf.Timestamp
                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                    done bool
                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                    metadata google.protobuf.Any<CreateClusterMetadata>
                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                    result oneof: error или response
                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                      error google.rpc.Status
                    Описание ошибки в случае сбоя или отмены операции.
                      response google.protobuf.Any<Cluster>
                    в случае успешного выполнения операции.

                    CreateClusterMetadata

                    Поле Описание
                    cluster_id string
                    Идентификатор кластера Apache Kafka®, который создается.

                    Cluster

                    Поле Описание
                    id string
                    Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
                    folder_id string
                    Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
                    created_at google.protobuf.Timestamp
                    Время создания.
                    name string
                    Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                    description string
                    Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
                    labels map<string,string>
                    Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
                    environment enum Environment
                    Среда развертывания кластера Apache Kafka®.
                    • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
                    • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
                      monitoring[] Monitoring
                      Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
                      config ConfigSpec
                      Конфигурация кластера Apache Kafka®.
                      network_id string
                      Идентификатор сети, к которой принадлежит кластер.
                      health enum Health
                      Здоровье кластера.
                      • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
                      • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
                      • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
                      • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
                        status enum Status
                        Текущее состояние кластера.
                        • STATUS_UNKNOWN: Состояние кластера неизвестно.
                        • CREATING: Кластер создается.
                        • RUNNING: Кластер работает нормально.
                        • ERROR: В кластере произошла ошибка, блокирующая работу.
                        • UPDATING: Кластер изменяется.
                        • STOPPING: Кластер останавливается.
                        • STOPPED: Кластер остановлен.
                        • STARTING: Кластер запускается.

                          Monitoring

                          Поле Описание
                          name string
                          Название системы мониторинга.
                          description string
                          Описание системы мониторинга.
                          link string
                          Ссылка на графики системы мониторинга для кластера Apache Kafka®.

                          ConfigSpec

                          Поле Описание
                          version string
                          Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                          kafka Kafka
                          Конфигурация и распределение ресурсов для брокеров Kafka.
                          zookeeper Zookeeper
                          Конфигурация и распределение ресурсов для хостов ZooKeeper.
                          zone_id[] string
                          Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                          brokers_count google.protobuf.Int64Value
                          Количество брокеров Kafka, развернутых в каждой зоне доступности.
                          assign_public_ip bool
                          Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                          Kafka

                          Поле Описание
                          resources Resources
                          Вычислительные ресурсы, выделенные брокерам Kafka.
                          kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                          Конфигурация брокера Kafka.
                            kafka_config_2_1 KafkaConfig2_1
                          Конфигурация брокера Kafka.
                            kafka_config_2_6 KafkaConfig2_6
                          Конфигурация брокера Kafka.

                          Zookeeper

                          Поле Описание
                          resources Resources
                          Вычислительные ресурсы, выделенные хостам ZooKeeper.

                          Update

                          Изменяет указанный кластер Apache Kafka®.

                          rpc Update (UpdateClusterRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:UpdateClusterMetadata

                              Operation.response:Cluster

                          UpdateClusterRequest

                          Поле Описание
                          cluster_id string
                          Обязательное поле. Идентификатор кластера Apache Kafka®, который нужно изменить.
                          Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50.
                          update_mask google.protobuf.FieldMask
                          description string
                          Новое описание кластера Apache Kafka®. Максимальная длина строки в символах — 256.
                          labels map<string,string>
                          Пользовательские метки для кластера Apache Kafka® в виде пар key:value.
                          Например, "project": "mvp" или "source": "dictionary".
                          Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода ClusterService.Get, затем отправьте запрос ClusterService.Update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                          config_spec ConfigSpec
                          Новая конфигурация Kafka и хостов кластера Apache Kafka®.
                          Используйте параметр update_mask чтобы предотвратить сброс настроек кластера, не перечисленных в config_spec, на значения по умолчанию.
                          name string
                          Новое имя кластера Apache Kafka®. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                          ConfigSpec

                          Поле Описание
                          version string
                          Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                          kafka Kafka
                          Конфигурация и распределение ресурсов для брокеров Kafka.
                          zookeeper Zookeeper
                          Конфигурация и распределение ресурсов для хостов ZooKeeper.
                          zone_id[] string
                          Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                          brokers_count google.protobuf.Int64Value
                          Количество брокеров Kafka, развернутых в каждой зоне доступности.
                          assign_public_ip bool
                          Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                          Kafka

                          Поле Описание
                          resources Resources
                          Вычислительные ресурсы, выделенные брокерам Kafka.
                          kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                          Конфигурация брокера Kafka.
                            kafka_config_2_1 KafkaConfig2_1
                          Конфигурация брокера Kafka.
                            kafka_config_2_6 KafkaConfig2_6
                          Конфигурация брокера Kafka.

                          Zookeeper

                          Поле Описание
                          resources Resources
                          Вычислительные ресурсы, выделенные хостам ZooKeeper.

                          Operation

                          Поле Описание
                          id string
                          Идентификатор операции.
                          description string
                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                          created_at google.protobuf.Timestamp
                          Время создания ресурса в формате в RFC3339.
                          created_by string
                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                          modified_at google.protobuf.Timestamp
                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                          done bool
                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                          metadata google.protobuf.Any<UpdateClusterMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                          result oneof: error или response
                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                            error google.rpc.Status
                          Описание ошибки в случае сбоя или отмены операции.
                            response google.protobuf.Any<Cluster>
                          в случае успешного выполнения операции.

                          UpdateClusterMetadata

                          Поле Описание
                          cluster_id string
                          Идентификатор кластера Apache Kafka®, который изменяется.

                          Cluster

                          Поле Описание
                          id string
                          Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
                          folder_id string
                          Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
                          created_at google.protobuf.Timestamp
                          Время создания.
                          name string
                          Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                          description string
                          Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
                          labels map<string,string>
                          Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
                          environment enum Environment
                          Среда развертывания кластера Apache Kafka®.
                          • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
                          • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
                            monitoring[] Monitoring
                            Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
                            config ConfigSpec
                            Конфигурация кластера Apache Kafka®.
                            network_id string
                            Идентификатор сети, к которой принадлежит кластер.
                            health enum Health
                            Здоровье кластера.
                            • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
                            • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
                            • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
                            • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
                              status enum Status
                              Текущее состояние кластера.
                              • STATUS_UNKNOWN: Состояние кластера неизвестно.
                              • CREATING: Кластер создается.
                              • RUNNING: Кластер работает нормально.
                              • ERROR: В кластере произошла ошибка, блокирующая работу.
                              • UPDATING: Кластер изменяется.
                              • STOPPING: Кластер останавливается.
                              • STOPPED: Кластер остановлен.
                              • STARTING: Кластер запускается.

                                Monitoring

                                Поле Описание
                                name string
                                Название системы мониторинга.
                                description string
                                Описание системы мониторинга.
                                link string
                                Ссылка на графики системы мониторинга для кластера Apache Kafka®.

                                ConfigSpec

                                Поле Описание
                                version string
                                Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                                kafka Kafka
                                Конфигурация и распределение ресурсов для брокеров Kafka.
                                zookeeper Zookeeper
                                Конфигурация и распределение ресурсов для хостов ZooKeeper.
                                zone_id[] string
                                Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                                brokers_count google.protobuf.Int64Value
                                Количество брокеров Kafka, развернутых в каждой зоне доступности.
                                assign_public_ip bool
                                Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                                Kafka

                                Поле Описание
                                resources Resources
                                Вычислительные ресурсы, выделенные брокерам Kafka.
                                kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                                Конфигурация брокера Kafka.
                                  kafka_config_2_1 KafkaConfig2_1
                                Конфигурация брокера Kafka.
                                  kafka_config_2_6 KafkaConfig2_6
                                Конфигурация брокера Kafka.

                                Zookeeper

                                Поле Описание
                                resources Resources
                                Вычислительные ресурсы, выделенные хостам ZooKeeper.

                                Delete

                                Удаляет указанный кластер Apache Kafka®.

                                rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                                Метаданные и результат операции:

                                    Operation.metadata:DeleteClusterMetadata

                                    Operation.response:google.protobuf.Empty

                                DeleteClusterRequest

                                Поле Описание
                                cluster_id string
                                Обязательное поле. Идентификатор кластера Apache Kafka®, который следует удалить.
                                Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50.

                                Operation

                                Поле Описание
                                id string
                                Идентификатор операции.
                                description string
                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                created_at google.protobuf.Timestamp
                                Время создания ресурса в формате в RFC3339.
                                created_by string
                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                modified_at google.protobuf.Timestamp
                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                done bool
                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                metadata google.protobuf.Any<DeleteClusterMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                result oneof: error или response
                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                  error google.rpc.Status
                                Описание ошибки в случае сбоя или отмены операции.
                                  response google.protobuf.Any<google.protobuf.Empty>
                                в случае успешного выполнения операции.

                                DeleteClusterMetadata

                                Поле Описание
                                cluster_id string
                                Идентификатор кластера Apache Kafka®, который удаляется.

                                Move

                                Перемещает кластер Apache Kafka® в указанный каталог.

                                rpc Move (MoveClusterRequest) returns (operation.Operation)

                                Метаданные и результат операции:

                                    Operation.metadata:MoveClusterMetadata

                                    Operation.response:Cluster

                                MoveClusterRequest

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

                                Operation

                                Поле Описание
                                id string
                                Идентификатор операции.
                                description string
                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                created_at google.protobuf.Timestamp
                                Время создания ресурса в формате в RFC3339.
                                created_by string
                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                modified_at google.protobuf.Timestamp
                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                done bool
                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                metadata google.protobuf.Any<MoveClusterMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                result oneof: error или response
                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                  error google.rpc.Status
                                Описание ошибки в случае сбоя или отмены операции.
                                  response google.protobuf.Any<Cluster>
                                в случае успешного выполнения операции.

                                MoveClusterMetadata

                                Поле Описание
                                cluster_id string
                                Идентификатор перемещаемого кластера Apache Kafka®.
                                source_folder_id string
                                Идентификатор исходного каталога.
                                destination_folder_id string
                                Идентификатор каталога назначения.

                                Cluster

                                Поле Описание
                                id string
                                Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
                                folder_id string
                                Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
                                created_at google.protobuf.Timestamp
                                Время создания.
                                name string
                                Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                description string
                                Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
                                labels map<string,string>
                                Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
                                environment enum Environment
                                Среда развертывания кластера Apache Kafka®.
                                • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
                                • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
                                  monitoring[] Monitoring
                                  Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
                                  config ConfigSpec
                                  Конфигурация кластера Apache Kafka®.
                                  network_id string
                                  Идентификатор сети, к которой принадлежит кластер.
                                  health enum Health
                                  Здоровье кластера.
                                  • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
                                  • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
                                  • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
                                  • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
                                    status enum Status
                                    Текущее состояние кластера.
                                    • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                    • CREATING: Кластер создается.
                                    • RUNNING: Кластер работает нормально.
                                    • ERROR: В кластере произошла ошибка, блокирующая работу.
                                    • UPDATING: Кластер изменяется.
                                    • STOPPING: Кластер останавливается.
                                    • STOPPED: Кластер остановлен.
                                    • STARTING: Кластер запускается.

                                      Monitoring

                                      Поле Описание
                                      name string
                                      Название системы мониторинга.
                                      description string
                                      Описание системы мониторинга.
                                      link string
                                      Ссылка на графики системы мониторинга для кластера Apache Kafka®.

                                      ConfigSpec

                                      Поле Описание
                                      version string
                                      Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                                      kafka Kafka
                                      Конфигурация и распределение ресурсов для брокеров Kafka.
                                      zookeeper Zookeeper
                                      Конфигурация и распределение ресурсов для хостов ZooKeeper.
                                      zone_id[] string
                                      Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                                      brokers_count google.protobuf.Int64Value
                                      Количество брокеров Kafka, развернутых в каждой зоне доступности.
                                      assign_public_ip bool
                                      Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                                      Kafka

                                      Поле Описание
                                      resources Resources
                                      Вычислительные ресурсы, выделенные брокерам Kafka.
                                      kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                                      Конфигурация брокера Kafka.
                                        kafka_config_2_1 KafkaConfig2_1
                                      Конфигурация брокера Kafka.
                                        kafka_config_2_6 KafkaConfig2_6
                                      Конфигурация брокера Kafka.

                                      Zookeeper

                                      Поле Описание
                                      resources Resources
                                      Вычислительные ресурсы, выделенные хостам ZooKeeper.

                                      Start

                                      Запускает указанный кластер Apache Kafka®.

                                      rpc Start (StartClusterRequest) returns (operation.Operation)

                                      Метаданные и результат операции:

                                          Operation.metadata:StartClusterMetadata

                                          Operation.response:Cluster

                                      StartClusterRequest

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

                                      Operation

                                      Поле Описание
                                      id string
                                      Идентификатор операции.
                                      description string
                                      Описание операции. Длина описания должна быть от 0 до 256 символов.
                                      created_at google.protobuf.Timestamp
                                      Время создания ресурса в формате в RFC3339.
                                      created_by string
                                      Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                      modified_at google.protobuf.Timestamp
                                      Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                      done bool
                                      Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                      metadata google.protobuf.Any<StartClusterMetadata>
                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                      result oneof: error или response
                                      Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                        error google.rpc.Status
                                      Описание ошибки в случае сбоя или отмены операции.
                                        response google.protobuf.Any<Cluster>
                                      в случае успешного выполнения операции.

                                      StartClusterMetadata

                                      Поле Описание
                                      cluster_id string
                                      Идентификатор кластера Apache Kafka®.

                                      Cluster

                                      Поле Описание
                                      id string
                                      Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
                                      folder_id string
                                      Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
                                      created_at google.protobuf.Timestamp
                                      Время создания.
                                      name string
                                      Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                      description string
                                      Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
                                      labels map<string,string>
                                      Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
                                      environment enum Environment
                                      Среда развертывания кластера Apache Kafka®.
                                      • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
                                      • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
                                        monitoring[] Monitoring
                                        Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
                                        config ConfigSpec
                                        Конфигурация кластера Apache Kafka®.
                                        network_id string
                                        Идентификатор сети, к которой принадлежит кластер.
                                        health enum Health
                                        Здоровье кластера.
                                        • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
                                        • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
                                        • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
                                        • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
                                          status enum Status
                                          Текущее состояние кластера.
                                          • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                          • CREATING: Кластер создается.
                                          • RUNNING: Кластер работает нормально.
                                          • ERROR: В кластере произошла ошибка, блокирующая работу.
                                          • UPDATING: Кластер изменяется.
                                          • STOPPING: Кластер останавливается.
                                          • STOPPED: Кластер остановлен.
                                          • STARTING: Кластер запускается.

                                            Monitoring

                                            Поле Описание
                                            name string
                                            Название системы мониторинга.
                                            description string
                                            Описание системы мониторинга.
                                            link string
                                            Ссылка на графики системы мониторинга для кластера Apache Kafka®.

                                            ConfigSpec

                                            Поле Описание
                                            version string
                                            Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                                            kafka Kafka
                                            Конфигурация и распределение ресурсов для брокеров Kafka.
                                            zookeeper Zookeeper
                                            Конфигурация и распределение ресурсов для хостов ZooKeeper.
                                            zone_id[] string
                                            Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                                            brokers_count google.protobuf.Int64Value
                                            Количество брокеров Kafka, развернутых в каждой зоне доступности.
                                            assign_public_ip bool
                                            Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                                            Kafka

                                            Поле Описание
                                            resources Resources
                                            Вычислительные ресурсы, выделенные брокерам Kafka.
                                            kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                                            Конфигурация брокера Kafka.
                                              kafka_config_2_1 KafkaConfig2_1
                                            Конфигурация брокера Kafka.
                                              kafka_config_2_6 KafkaConfig2_6
                                            Конфигурация брокера Kafka.

                                            Zookeeper

                                            Поле Описание
                                            resources Resources
                                            Вычислительные ресурсы, выделенные хостам ZooKeeper.

                                            Stop

                                            Останавливает указанный кластер Apache Kafka®.

                                            rpc Stop (StopClusterRequest) returns (operation.Operation)

                                            Метаданные и результат операции:

                                                Operation.metadata:StopClusterMetadata

                                                Operation.response:Cluster

                                            StopClusterRequest

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

                                            Operation

                                            Поле Описание
                                            id string
                                            Идентификатор операции.
                                            description string
                                            Описание операции. Длина описания должна быть от 0 до 256 символов.
                                            created_at google.protobuf.Timestamp
                                            Время создания ресурса в формате в RFC3339.
                                            created_by string
                                            Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                            modified_at google.protobuf.Timestamp
                                            Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                            done bool
                                            Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                            metadata google.protobuf.Any<StopClusterMetadata>
                                            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                            result oneof: error или response
                                            Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                              error google.rpc.Status
                                            Описание ошибки в случае сбоя или отмены операции.
                                              response google.protobuf.Any<Cluster>
                                            в случае успешного выполнения операции.

                                            StopClusterMetadata

                                            Поле Описание
                                            cluster_id string
                                            Идентификатор кластера Apache Kafka®.

                                            Cluster

                                            Поле Описание
                                            id string
                                            Идентификатор кластера Apache Kafka®. Этот идентификатор генерируется при создании кластера.
                                            folder_id string
                                            Идентификатор каталога, которому принадлежит кластер Apache Kafka®.
                                            created_at google.protobuf.Timestamp
                                            Время создания.
                                            name string
                                            Имя кластера Apache Kafka®. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                            description string
                                            Описание кластера Apache Kafka®. Длина описания должна быть от 0 до 256 символов.
                                            labels map<string,string>
                                            Пользовательские метки для кластера Apache Kafka® в виде пар key:value. Максимум 64 на ресурс.
                                            environment enum Environment
                                            Среда развертывания кластера Apache Kafka®.
                                            • PRODUCTION: Стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
                                            • PRESTABLE: Среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
                                              monitoring[] Monitoring
                                              Описание систем мониторинга, относящихся к кластеру Apache Kafka®.
                                              config ConfigSpec
                                              Конфигурация кластера Apache Kafka®.
                                              network_id string
                                              Идентификатор сети, к которой принадлежит кластер.
                                              health enum Health
                                              Здоровье кластера.
                                              • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health всех хостов в кластере — UNKNOWN).
                                              • ALIVE: Кластер работает нормально (Host.health всех хостов в кластере — ALIVE).
                                              • DEAD: Кластер не работает (Host.health всех хостов в кластере — DEAD).
                                              • DEGRADED: Кластер находится в состоянии деградации (Host.health по крайней мере одного из хостов в кластере — не ALIVE).
                                                status enum Status
                                                Текущее состояние кластера.
                                                • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                                • CREATING: Кластер создается.
                                                • RUNNING: Кластер работает нормально.
                                                • ERROR: В кластере произошла ошибка, блокирующая работу.
                                                • UPDATING: Кластер изменяется.
                                                • STOPPING: Кластер останавливается.
                                                • STOPPED: Кластер остановлен.
                                                • STARTING: Кластер запускается.

                                                  Monitoring

                                                  Поле Описание
                                                  name string
                                                  Название системы мониторинга.
                                                  description string
                                                  Описание системы мониторинга.
                                                  link string
                                                  Ссылка на графики системы мониторинга для кластера Apache Kafka®.

                                                  ConfigSpec

                                                  Поле Описание
                                                  version string
                                                  Версия Apache Kafka®, которая используется в кластере. Возможные значения: 2.1, 2.6.
                                                  kafka Kafka
                                                  Конфигурация и распределение ресурсов для брокеров Kafka.
                                                  zookeeper Zookeeper
                                                  Конфигурация и распределение ресурсов для хостов ZooKeeper.
                                                  zone_id[] string
                                                  Идентификаторы зон доступности, в которых находятся брокеры Kafka.
                                                  brokers_count google.protobuf.Int64Value
                                                  Количество брокеров Kafka, развернутых в каждой зоне доступности.
                                                  assign_public_ip bool
                                                  Флаг, определяющий, назначен ли кластеру публичный IP-адрес. Если значение равно true, то кластер Apache Kafka® доступен в Интернете через его публичный IP-адрес.

                                                  Kafka

                                                  Поле Описание
                                                  resources Resources
                                                  Вычислительные ресурсы, выделенные брокерам Kafka.
                                                  kafka_config oneof: kafka_config_2_1 или kafka_config_2_6
                                                  Конфигурация брокера Kafka.
                                                    kafka_config_2_1 KafkaConfig2_1
                                                  Конфигурация брокера Kafka.
                                                    kafka_config_2_6 KafkaConfig2_6
                                                  Конфигурация брокера Kafka.

                                                  Zookeeper

                                                  Поле Описание
                                                  resources Resources
                                                  Вычислительные ресурсы, выделенные хостам ZooKeeper.

                                                  ListLogs

                                                  Получает логи для указанного кластера Apache Kafka®.
                                                  Дополнительные сведения о логах см. в разделе Logs документации.

                                                  rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

                                                  ListClusterLogsRequest

                                                  Поле Описание
                                                  cluster_id string
                                                  Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить логи.
                                                  Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                  column_filter[] string
                                                  Столбцы, которые нужно запросить из лога.
                                                  Если столбцы не указаны, записи логов возвращаются целиком.
                                                  from_time google.protobuf.Timestamp
                                                  Временная метка, начиная с которой следует запросить логи.
                                                  to_time google.protobuf.Timestamp
                                                  Временная метка, до которой следует запросить логи.
                                                  page_size int64
                                                  Максимальное количество результатов на одной странице в ответе.
                                                  Если количество результатов больше чем page_size, сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                  page_token string
                                                  Токен страницы.
                                                  Установите значение page_token равным значению поля ListClusterLogsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
                                                  always_next_page_token bool
                                                  Флаг, определяющий поведение при предоставлении маркера следующей страницы.
                                                  Если этот флаг установлен в true, этот метод API всегда будет возвращать ListClusterLogsResponse.next_page_token, даже если текущая страница пуста.
                                                  filter string
                                                  1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю hostname.
                                                  2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений.
                                                  3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-z0-9.-]{1,61}$.
                                                  Максимальная длина строки в символах — 1000.

                                                  ListClusterLogsResponse

                                                  Поле Описание
                                                  logs[] LogRecord
                                                  Запрошенные записи в логе.
                                                  next_page_token string
                                                  Токен для получения следующей страницы результатов в ответе.
                                                  Если количество результатов больше чем ListClusterLogsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterLogsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. Это значение взаимозаменяемо с StreamLogRecord.next_record_token из метода StreamLogs.

                                                  LogRecord

                                                  Поле Описание
                                                  timestamp google.protobuf.Timestamp
                                                  Временная метка для записи в логе.
                                                  message map<string,string>
                                                  Содержимое записи в логе.

                                                  StreamLogs

                                                  То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов. Допускается использовать семантику tail -f при работе с потоком логов.

                                                  rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

                                                  StreamClusterLogsRequest

                                                  Поле Описание
                                                  cluster_id string
                                                  Обязательное поле. Идентификатор кластера Apache Kafka®.
                                                  Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                  column_filter[] string
                                                  Столбцы, которые нужно запросить из лога.
                                                  Если столбцы не указаны, записи логов возвращаются целиком.
                                                  from_time google.protobuf.Timestamp
                                                  Временная метка, начиная с которой следует запросить логи.
                                                  to_time google.protobuf.Timestamp
                                                  Временная метка, до которой следует запросить логи.
                                                  Если значение этого поля не задано, то будут отправлены все существующие записи в логе, а затем и новые по мере их появления. В сущности, это эквивалентно семантике tail -f.
                                                  record_token string
                                                  Токен записи.
                                                  Задайте значение record_token равным значению StreamLogRecord.next_record_token, возвращенному предыдущим запросом ClusterService.StreamLogs чтобы продолжить стриминг со следующей записи в логе. Максимальная длина строки в символах — 100.
                                                  filter string
                                                  1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю hostname.
                                                  2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений.
                                                  3. Значение. Должно содержать от 3 до 63 символов и соответствовать регулярному выражению ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.
                                                  Максимальная длина строки в символах — 1000.

                                                  StreamLogRecord

                                                  Поле Описание
                                                  record LogRecord
                                                  Одна из запрошенных записей в логе.
                                                  next_record_token string
                                                  Этот токен позволяет продолжить работу с потоком логов, начиная с этой записи.
                                                  Чтобы продолжить работу с потоком, укажите значение next_record_token в качестве значения параметра StreamClusterLogsRequest.record_token в следующем запросе StreamLogs.
                                                  Это значение взаимозаменяемо с ListClusterLogsResponse.next_page_token из метода ListLogs.

                                                  LogRecord

                                                  Поле Описание
                                                  timestamp google.protobuf.Timestamp
                                                  Временная метка для записи в логе.
                                                  message map<string,string>
                                                  Содержимое записи в логе.

                                                  ListOperations

                                                  Получает список операций для указанного кластера Apache Kafka®.

                                                  rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                  ListClusterOperationsRequest

                                                  Поле Описание
                                                  cluster_id string
                                                  Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить список операций. Максимальная длина строки в символах — 50.
                                                  page_size int64
                                                  Максимальное количество результатов на одной странице в ответе.
                                                  Если количество результатов больше чем page_size, сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                  page_token string
                                                  Токен страницы.
                                                  Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                  ListClusterOperationsResponse

                                                  Поле Описание
                                                  operations[] operation.Operation
                                                  Получает список операций для указанного кластера Apache Kafka®.
                                                  next_page_token string
                                                  Токен для получения следующей страницы результатов в ответе.
                                                  Если количество результатов больше чем ListClusterOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                  Operation

                                                  Поле Описание
                                                  id string
                                                  Идентификатор операции.
                                                  description string
                                                  Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                  created_at google.protobuf.Timestamp
                                                  Время создания ресурса в формате в RFC3339.
                                                  created_by string
                                                  Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                  modified_at google.protobuf.Timestamp
                                                  Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                  done bool
                                                  Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                  metadata google.protobuf.Any
                                                  Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                  result oneof: error или response
                                                  Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                    error google.rpc.Status
                                                  Описание ошибки в случае сбоя или отмены операции.
                                                    response google.protobuf.Any
                                                  Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

                                                  ListHosts

                                                  Получает список хостов для указанного кластера Apache Kafka®.

                                                  rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

                                                  ListClusterHostsRequest

                                                  Поле Описание
                                                  cluster_id string
                                                  Обязательное поле. Идентификатор кластера Apache Kafka®.
                                                  Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                  page_size int64
                                                  Максимальное количество результатов на одной странице в ответе.
                                                  Если количество результатов больше чем page_size, сервис вернет значение ListClusterHostsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                  page_token string
                                                  Токен страницы.
                                                  Установите значение page_token равным значению поля ListClusterHostsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                  ListClusterHostsResponse

                                                  Поле Описание
                                                  hosts[] Host
                                                  Список хостов.
                                                  next_page_token string
                                                  Токен для получения следующей страницы результатов в ответе.
                                                  Если количество результатов больше чем ListClusterHostsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterHostsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                  Host

                                                  Поле Описание
                                                  name string
                                                  Имя хоста.
                                                  cluster_id string
                                                  Идентификатор кластера Apache Kafka®.
                                                  zone_id string
                                                  Идентификатор зоны доступности, в которой находится хост.
                                                  role enum Role
                                                  Роль хоста.
                                                  • KAFKA: хост — брокер Kafka.
                                                  • ZOOKEEPER: хост — сервер ZooKeeper.
                                                    resources Resources
                                                    Вычислительные ресурсы, выделенные хосту.
                                                    health enum Health
                                                    Агрегированные данные о работоспособности хоста.
                                                    • UNKNOWN: состояние хоста неизвестно.
                                                    • ALIVE: хост работает и выполняет все свои функции.
                                                    • DEAD: хост не работает и не выполняет свои функции.
                                                    • DEGRADED: хост находится в состоянии деградации и может выполнять только некоторые свои функции.
                                                      subnet_id string
                                                      Идентификатор подсети, в которой находится хост.
                                                      assign_public_ip bool
                                                      Флаг, определяющий, назначен ли хосту публичный IP-адрес.
                                                      Если значение равно true, то этот хост доступен в Интернете через его публичный IP-адрес.

                                                      Resources

                                                      Поле Описание
                                                      resource_preset_id string
                                                      Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                      disk_size int64
                                                      Объем хранилища, доступного хосту, в байтах.
                                                      disk_type_id string
                                                      Тип хранилища для хоста.
                                                      В этой статье: