Подключиться
Войти
Yandex Managed Service for ClickHouse

ClusterService

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

Вызов Описание
Get Возвращает указанный ClickHouse-кластер.
List Получает список ClickHouse-кластеров, принадлежащих указанному каталогу.
Create Создает кластер ClickHouse в указанном каталоге.
Update Изменяет указанный кластер ClickHouse.
Delete Удаляет указанный кластер ClickHouse.
Start Запускает указанный кластер ClickHouse.
Stop Останавливает указанный кластер ClickHouse.
Move Перемещает кластер ClickHouse в указанный каталог.
AddZookeeper Добавляет подкластер ZooKeeper в указанный кластер ClickHouse.
Backup Создает резервную копию для указанного кластера ClickHouse.
Restore Создает новый кластер ClickHouse с использованием указанной резервной копии.
ListLogs Получает логи для указанного кластера ClickHouse.
ListOperations Получает список ресурсов Operation для указанного кластера.
ListBackups Получает список доступных резервных копий для указанного кластера ClickHouse.
ListHosts Получает список хостов для указанного кластера.
AddHosts Создает новые хосты для кластера.
DeleteHosts Удаляет указанные хосты кластера.
GetShard Возвращает указанный шард.
ListShards Получает список шардов, принадлежащих указанному кластеру.
AddShard Создает новый шард в указанном кластере.
UpdateShard Изменяет указанный шард.
DeleteShard Удаляет указанный шард.
CreateExternalDictionary Создает внешний словарь для указанного кластера ClickHouse.
DeleteExternalDictionary Удаляет указанный внешний словарь.

Вызовы ClusterService

Get

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

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

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

Cluster

Поле Описание
id string
Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
folder_id string
Идентификатор каталога, которому принадлежит кластер ClickHouse.
created_at google.protobuf.Timestamp
Время создания в формате RFC3339 .
name string
Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
description string
Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
environment enum Environment
Среда развертывания кластера ClickHouse.
  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
    monitoring[] Monitoring
    Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
    config ClusterConfig
    Конфигурация кластера ClickHouse.
    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
        Ссылка на графики системы мониторинга для данного кластера ClickHouse.

        ClusterConfig

        Поле Описание
        version string
        Версия серверного программного обеспечения ClickHouse.
        clickhouse Clickhouse
        Конфигурация и распределение ресурсов для хостов ClickHouse.
        zookeeper Zookeeper
        Конфигурация и распределение ресурсов для хостов ZooKeeper.
        backup_window_start google.type.TimeOfDay
        Время запуска ежедневного резервного копирования, в часовом поясе UTC.

        Clickhouse

        Поле Описание
        config config.ClickhouseConfigSet
        Параметры конфигурации сервера ClickHouse.
        resources Resources
        Ресурсы, выделенные хостам ClickHouse.

        Zookeeper

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

        List

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

        rpc List (ListClustersRequest) returns (ListClustersResponse)

        ListClustersRequest

        Поле Описание
        folder_id string
        Обязательное поле. Идентификатор каталога для вывода списка кластеров ClickHouse. Чтобы получить идентификатор каталога, используйте запрос 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
        Список ресурсов Cluster для ClickHouse.
        next_page_token string
        Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

        Cluster

        Поле Описание
        id string
        Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
        folder_id string
        Идентификатор каталога, которому принадлежит кластер ClickHouse.
        created_at google.protobuf.Timestamp
        Время создания в формате RFC3339 .
        name string
        Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
        description string
        Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
        labels map<string,string>
        Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
        environment enum Environment
        Среда развертывания кластера ClickHouse.
        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
          monitoring[] Monitoring
          Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
          config ClusterConfig
          Конфигурация кластера ClickHouse.
          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
              Ссылка на графики системы мониторинга для данного кластера ClickHouse.

              ClusterConfig

              Поле Описание
              version string
              Версия серверного программного обеспечения ClickHouse.
              clickhouse Clickhouse
              Конфигурация и распределение ресурсов для хостов ClickHouse.
              zookeeper Zookeeper
              Конфигурация и распределение ресурсов для хостов ZooKeeper.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.

              Clickhouse

              Поле Описание
              config config.ClickhouseConfigSet
              Параметры конфигурации сервера ClickHouse.
              resources Resources
              Ресурсы, выделенные хостам ClickHouse.

              Zookeeper

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

              Create

              Создает кластер ClickHouse в указанном каталоге.

              rpc Create (CreateClusterRequest) returns (operation.Operation)

              Метаданные и результат операции:
                  Operation.metadata:CreateClusterMetadata
                  Operation.response:Cluster

              CreateClusterRequest

              Поле Описание
              folder_id string
              Обязательное поле. Идентификатор каталога, в котором нужно создать кластер ClickHouse. Максимальная длина строки в символах — 50.
              name string
              Обязательное поле. Имя кластера ClickHouse. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
              description string
              Описание кластера ClickHouse. Максимальная длина строки в символах — 256.
              labels map<string,string>
              Пользовательские метки для кластера ClickHouse как пары key:value. Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
              environment Cluster.Environment
              Обязательное поле. Среда развертывания кластера ClickHouse.
              config_spec ConfigSpec
              Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера ClickHouse.
              database_specs[] DatabaseSpec
              Описания баз данных, которые нужно создать в кластере ClickHouse. Количество элементов должно быть больше 0.
              user_specs[] UserSpec
              Описания пользователей базы данных, которых нужно создать в кластере ClickHouse. Количество элементов должно быть больше 0.
              host_specs[] HostSpec
              Конфигурации для отдельных хостов, которые должны быть созданы для кластера ClickHouse. Количество элементов должно быть больше 0.
              network_id string
              Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.
              shard_name string
              Имя первого шарда в кластере. Если параметр не указан, используется значение shard1. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

              ConfigSpec

              Поле Описание
              version string
              Версия серверного программного обеспечения ClickHouse.
              clickhouse Clickhouse
              Конфигурация и ресурсы для сервера ClickHouse.
              zookeeper Zookeeper
              Конфигурация и ресурсы для сервера ZooKeeper.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.

              Clickhouse

              Поле Описание
              config config.ClickhouseConfig
              Конфигурация для сервера ClickHouse.
              resources Resources
              Ресурсы, выделенные хостам ClickHouse.

              Zookeeper

              Поле Описание
              resources Resources
              Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List.

              DatabaseSpec

              Поле Описание
              name string
              Обязательное поле. Имя базы данных ClickHouse. Длина 1-63 символов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

              UserSpec

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

              Permission

              Поле Описание
              database_name string
              Имя базы данных, к которой предоставляет доступ разрешение.

              UserSettings

              Поле Описание
              readonly google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно.
              allow_ddl google.protobuf.BoolValue
              См. подробное описание в документации ClickHouse.
              insert_quorum google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Минимальная значение — 0.
              insert_quorum_timeout google.protobuf.Int64Value
              1. См.
              Минимальная значение — 1000.
              select_sequential_consistency google.protobuf.BoolValue
              См. подробное описание в документации ClickHouse.
              max_replica_delay_for_distributed_queries google.protobuf.Int64Value
              1. См. подробное описание в документации ClickHouse.
              Минимальная значение — 1000.
              fallback_to_stale_replicas_for_distributed_queries google.protobuf.BoolValue
              См. подробное описание в документации ClickHouse.
              max_threads google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
              max_block_size google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
              max_insert_block_size google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
              max_memory_usage google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Минимальная значение — 0.
              max_memory_usage_for_user google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Минимальная значение — 0.
              max_rows_to_read google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Минимальная значение — 0.
              max_bytes_to_read google.protobuf.Int64Value
              См. подробное описание в документации ClickHouse. Минимальная значение — 0.
              read_overflow_mode enum OverflowMode
              См. подробное описание в документации ClickHouse.
                max_rows_to_group_by google.protobuf.Int64Value
                См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                group_by_overflow_mode enum GroupByOverflowMode
                См. подробное описание в документации ClickHouse.
                  max_rows_to_sort google.protobuf.Int64Value
                  См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                  max_bytes_to_sort google.protobuf.Int64Value
                  См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                  sort_overflow_mode enum OverflowMode
                  См. подробное описание в документации ClickHouse.
                    max_result_rows google.protobuf.Int64Value
                    См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                    max_result_bytes google.protobuf.Int64Value
                    См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                    result_overflow_mode enum OverflowMode
                    См. подробное описание в документации ClickHouse.
                      max_rows_in_distinct google.protobuf.Int64Value
                      См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                      max_bytes_in_distinct google.protobuf.Int64Value
                      См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                      distinct_overflow_mode enum OverflowMode
                      См. подробное описание в документации ClickHouse.
                        max_rows_to_transfer google.protobuf.Int64Value
                        См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                        max_bytes_to_transfer google.protobuf.Int64Value
                        См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                        transfer_overflow_mode enum OverflowMode
                        См. подробное описание в документации ClickHouse.
                          max_execution_time google.protobuf.Int64Value
                          Максимальное время выполнения запроса в миллисекундах. См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                          timeout_overflow_mode enum OverflowMode
                          См. подробное описание в документации ClickHouse.
                            max_columns_to_read google.protobuf.Int64Value
                            Максимальное количество столбцов, которые можно прочитать из таблицы в одном запросе. См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                            max_temporary_columns google.protobuf.Int64Value
                            Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, включая постоянные столбцы. См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                            max_temporary_non_const_columns google.protobuf.Int64Value
                            Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, за исключением постоянных столбцов. См. подробное описание в документации ClickHouse. Минимальная значение — 0.
                            max_query_size google.protobuf.Int64Value
                            1. См. подробное описание в документации ClickHouse.
                            Значение должно быть больше 0.
                            max_ast_depth google.protobuf.Int64Value
                            1. См.
                            Значение должно быть больше 0.
                            max_ast_elements google.protobuf.Int64Value
                            1. См. подробное описание в документации ClickHouse.
                            Значение должно быть больше 0.
                            max_expanded_ast_elements google.protobuf.Int64Value
                            Максимальный размер синтаксического дерева запроса в количестве узлов после раскрытия псевдонимов и звездочки. Значение по умолчанию: 500000. Значение должно быть больше 0.

                            HostSpec

                            Поле Описание
                            zone_id string
                            Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                            type Host.Type
                            Обязательное поле. Тип развертываемого хоста.
                            subnet_id string
                            Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                            assign_public_ip bool
                            • false — не назначать хосту публичный IP-адрес.
                            • true — у хоста должен быть публичный IP-адрес.
                            shard_name string
                            Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                            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
                            Идентификатор создаваемого кластера ClickHouse.

                            Cluster

                            Поле Описание
                            id string
                            Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                            folder_id string
                            Идентификатор каталога, которому принадлежит кластер ClickHouse.
                            created_at google.protobuf.Timestamp
                            Время создания в формате RFC3339 .
                            name string
                            Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                            description string
                            Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                            labels map<string,string>
                            Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                            environment enum Environment
                            Среда развертывания кластера ClickHouse.
                            • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                            • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                              monitoring[] Monitoring
                              Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                              config ClusterConfig
                              Конфигурация кластера ClickHouse.
                              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: Кластер запускается.

                                  Update

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

                                  rpc Update (UpdateClusterRequest) returns (operation.Operation)

                                  Метаданные и результат операции:
                                      Operation.metadata:UpdateClusterMetadata
                                      Operation.response:Cluster

                                  UpdateClusterRequest

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

                                  ConfigSpec

                                  Поле Описание
                                  version string
                                  Версия серверного программного обеспечения ClickHouse.
                                  clickhouse Clickhouse
                                  Конфигурация и ресурсы для сервера ClickHouse.
                                  zookeeper Zookeeper
                                  Конфигурация и ресурсы для сервера ZooKeeper.
                                  backup_window_start google.type.TimeOfDay
                                  Время запуска ежедневного резервного копирования, в часовом поясе UTC.

                                  Clickhouse

                                  Поле Описание
                                  config config.ClickhouseConfig
                                  Конфигурация для сервера ClickHouse.
                                  resources Resources
                                  Ресурсы, выделенные хостам ClickHouse.

                                  Zookeeper

                                  Поле Описание
                                  resources Resources
                                  Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List.

                                  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
                                  Идентификатор изменяемого ресурса Cluster для ClickHouse.

                                  Cluster

                                  Поле Описание
                                  id string
                                  Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                  folder_id string
                                  Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                  created_at google.protobuf.Timestamp
                                  Время создания в формате RFC3339 .
                                  name string
                                  Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                  description string
                                  Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                  labels map<string,string>
                                  Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                  environment enum Environment
                                  Среда развертывания кластера ClickHouse.
                                  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                    monitoring[] Monitoring
                                    Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                    config ClusterConfig
                                    Конфигурация кластера ClickHouse.
                                    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: Кластер запускается.

                                        Delete

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

                                        rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                                        Метаданные и результат операции:
                                            Operation.metadata:DeleteClusterMetadata
                                            Operation.response:google.protobuf.Empty

                                        DeleteClusterRequest

                                        Поле Описание
                                        cluster_id string
                                        Обязательное поле. Идентификатор кластера ClickHouse, который нужно удалить. Чтобы получить идентификатор кластера ClickHouse, используйте запрос 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
                                        Идентификатор удаляемого кластера ClickHouse.

                                        Start

                                        Запускает указанный кластер ClickHouse.

                                        rpc Start (StartClusterRequest) returns (operation.Operation)

                                        Метаданные и результат операции:
                                            Operation.metadata:StartClusterMetadata
                                            Operation.response:Cluster

                                        StartClusterRequest

                                        Поле Описание
                                        cluster_id string
                                        Обязательное поле. Идентификатор кластера ClickHouse, который следует запустить. Максимальная длина строки в символах — 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
                                        Идентификатор запускаемого кластера ClickHouse.

                                        Cluster

                                        Поле Описание
                                        id string
                                        Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                        folder_id string
                                        Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                        created_at google.protobuf.Timestamp
                                        Время создания в формате RFC3339 .
                                        name string
                                        Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                        description string
                                        Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                        labels map<string,string>
                                        Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                        environment enum Environment
                                        Среда развертывания кластера ClickHouse.
                                        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                          monitoring[] Monitoring
                                          Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                          config ClusterConfig
                                          Конфигурация кластера ClickHouse.
                                          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: Кластер запускается.

                                              Stop

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

                                              rpc Stop (StopClusterRequest) returns (operation.Operation)

                                              Метаданные и результат операции:
                                                  Operation.metadata:StopClusterMetadata
                                                  Operation.response:Cluster

                                              StopClusterRequest

                                              Поле Описание
                                              cluster_id string
                                              Обязательное поле. Идентификатор кластера ClickHouse, который следует остановить. Максимальная длина строки в символах — 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
                                              Идентификатор останавливаемого кластера ClickHouse.

                                              Cluster

                                              Поле Описание
                                              id string
                                              Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                              folder_id string
                                              Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                              created_at google.protobuf.Timestamp
                                              Время создания в формате RFC3339 .
                                              name string
                                              Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                              description string
                                              Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                              labels map<string,string>
                                              Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                              environment enum Environment
                                              Среда развертывания кластера ClickHouse.
                                              • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                              • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                monitoring[] Monitoring
                                                Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                config ClusterConfig
                                                Конфигурация кластера ClickHouse.
                                                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: Кластер запускается.

                                                    Move

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

                                                    rpc Move (MoveClusterRequest) returns (operation.Operation)

                                                    Метаданные и результат операции:
                                                        Operation.metadata:MoveClusterMetadata
                                                        Operation.response:Cluster

                                                    MoveClusterRequest

                                                    Поле Описание
                                                    cluster_id string
                                                    Обязательное поле. Идентификатор кластера ClickHouse, который следует переместить. Максимальная длина строки в символах — 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
                                                    Идентификатор перемещаемого кластера ClickHouse.
                                                    source_folder_id string
                                                    Идентификатор исходного каталога.
                                                    destination_folder_id string
                                                    Идентификатор каталога, в который следует переместить кластер.

                                                    Cluster

                                                    Поле Описание
                                                    id string
                                                    Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                    folder_id string
                                                    Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                    created_at google.protobuf.Timestamp
                                                    Время создания в формате RFC3339 .
                                                    name string
                                                    Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                    description string
                                                    Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                    labels map<string,string>
                                                    Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                    environment enum Environment
                                                    Среда развертывания кластера ClickHouse.
                                                    • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                    • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                      monitoring[] Monitoring
                                                      Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                      config ClusterConfig
                                                      Конфигурация кластера ClickHouse.
                                                      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: Кластер запускается.

                                                          AddZookeeper

                                                          Добавляет подкластер ZooKeeper в указанный кластер ClickHouse.

                                                          rpc AddZookeeper (AddClusterZookeeperRequest) returns (operation.Operation)

                                                          Метаданные и результат операции:
                                                              Operation.metadata:AddClusterZookeeperMetadata
                                                              Operation.response:Cluster

                                                          AddClusterZookeeperRequest

                                                          Поле Описание
                                                          cluster_id string
                                                          Обязательное поле. Идентификатор кластера ClickHouse, который следует изменить. Максимальная длина строки в символах — 50.
                                                          resources Resources
                                                          Ресурсы, выделенные хостам ZooKeeper.
                                                          host_specs[] HostSpec
                                                          Конфигурация хостов ZooKeeper.

                                                          Resources

                                                          Поле Описание
                                                          resource_preset_id string
                                                          Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                          disk_size int64
                                                          Объем хранилища, доступного хосту, в байтах.
                                                          disk_type_id string
                                                          • network-hdd — сетевой HDD-диск;
                                                          • network-ssd — сетевой SSD-диск;
                                                          • local-ssd — локальное SSD-хранилище.

                                                          HostSpec

                                                          Поле Описание
                                                          zone_id string
                                                          Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                          type Host.Type
                                                          Обязательное поле. Тип развертываемого хоста.
                                                          subnet_id string
                                                          Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                          assign_public_ip bool
                                                          • false — не назначать хосту публичный IP-адрес.
                                                          • true — у хоста должен быть публичный IP-адрес.
                                                          shard_name string
                                                          Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                          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<AddClusterZookeeperMetadata>
                                                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                          в случае успешного выполнения операции.

                                                          AddClusterZookeeperMetadata

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

                                                          Cluster

                                                          Поле Описание
                                                          id string
                                                          Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                          folder_id string
                                                          Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                          created_at google.protobuf.Timestamp
                                                          Время создания в формате RFC3339 .
                                                          name string
                                                          Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                          description string
                                                          Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                          labels map<string,string>
                                                          Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                          environment enum Environment
                                                          Среда развертывания кластера ClickHouse.
                                                          • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                          • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                            monitoring[] Monitoring
                                                            Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                            config ClusterConfig
                                                            Конфигурация кластера ClickHouse.
                                                            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: Кластер запускается.

                                                                Backup

                                                                Создает резервную копию для указанного кластера ClickHouse.

                                                                rpc Backup (BackupClusterRequest) returns (operation.Operation)

                                                                Метаданные и результат операции:
                                                                    Operation.metadata:BackupClusterMetadata
                                                                    Operation.response:Cluster

                                                                BackupClusterRequest

                                                                Поле Описание
                                                                cluster_id string
                                                                Обязательное поле. Идентификатор кластера ClickHouse, для которого следует создать резервную копию. Чтобы получить идентификатор кластера ClickHouse, используйте запрос 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<BackupClusterMetadata>
                                                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                в случае успешного выполнения операции.

                                                                BackupClusterMetadata

                                                                Поле Описание
                                                                cluster_id string
                                                                Идентификатор кластера ClickHouse, для которого выполняется резервное копирование.

                                                                Cluster

                                                                Поле Описание
                                                                id string
                                                                Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                                folder_id string
                                                                Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                                created_at google.protobuf.Timestamp
                                                                Время создания в формате RFC3339 .
                                                                name string
                                                                Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                                description string
                                                                Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                                labels map<string,string>
                                                                Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                                environment enum Environment
                                                                Среда развертывания кластера ClickHouse.
                                                                • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                                • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                                  monitoring[] Monitoring
                                                                  Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                                  config ClusterConfig
                                                                  Конфигурация кластера ClickHouse.
                                                                  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: Кластер запускается.

                                                                      Restore

                                                                      Создает новый кластер ClickHouse с использованием указанной резервной копии.

                                                                      rpc Restore (RestoreClusterRequest) returns (operation.Operation)

                                                                      Метаданные и результат операции:
                                                                          Operation.metadata:RestoreClusterMetadata
                                                                          Operation.response:Cluster

                                                                      RestoreClusterRequest

                                                                      Поле Описание
                                                                      backup_id string
                                                                      Обязательное поле. Идентификатор резервной копии, из которой следует создать кластер. Чтобы получить идентификатор резервной копии, используйте запрос ClusterService.ListBackups.
                                                                      name string
                                                                      Обязательное поле. Имя нового кластера ClickHouse. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                                      description string
                                                                      Описание нового кластера ClickHouse. Максимальная длина строки в символах — 256.
                                                                      labels map<string,string>
                                                                      Пользовательские метки для кластера ClickHouse key:value пары. Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                                                                      environment Cluster.Environment
                                                                      Обязательное поле. Среда развертывания для нового кластера ClickHouse.
                                                                      config_spec ConfigSpec
                                                                      Обязательное поле. Конфигурация для создаваемого кластера ClickHouse.
                                                                      host_specs[] HostSpec
                                                                      Конфигурации для хостов ClickHouse, которые должны быть созданы для кластера, создаваемого из резервной копии. Количество элементов должно быть больше 0.
                                                                      network_id string
                                                                      Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.

                                                                      ConfigSpec

                                                                      Поле Описание
                                                                      version string
                                                                      Версия серверного программного обеспечения ClickHouse.
                                                                      clickhouse Clickhouse
                                                                      Конфигурация и ресурсы для сервера ClickHouse.
                                                                      zookeeper Zookeeper
                                                                      Конфигурация и ресурсы для сервера ZooKeeper.
                                                                      backup_window_start google.type.TimeOfDay
                                                                      Время запуска ежедневного резервного копирования, в часовом поясе UTC.

                                                                      Clickhouse

                                                                      Поле Описание
                                                                      config config.ClickhouseConfig
                                                                      Конфигурация для сервера ClickHouse.
                                                                      resources Resources
                                                                      Ресурсы, выделенные хостам ClickHouse.

                                                                      Zookeeper

                                                                      Поле Описание
                                                                      resources Resources
                                                                      Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List.

                                                                      HostSpec

                                                                      Поле Описание
                                                                      zone_id string
                                                                      Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                      type Host.Type
                                                                      Обязательное поле. Тип развертываемого хоста.
                                                                      subnet_id string
                                                                      Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                      assign_public_ip bool
                                                                      • false — не назначать хосту публичный IP-адрес.
                                                                      • true — у хоста должен быть публичный IP-адрес.
                                                                      shard_name string
                                                                      Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                      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<RestoreClusterMetadata>
                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                      в случае успешного выполнения операции.

                                                                      RestoreClusterMetadata

                                                                      Поле Описание
                                                                      cluster_id string
                                                                      Идентификатор нового кластера ClickHouse, создаваемого из резервной копии.
                                                                      backup_id string
                                                                      Идентификатор резервной копии, используемой для создания кластера.

                                                                      Cluster

                                                                      Поле Описание
                                                                      id string
                                                                      Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                                      folder_id string
                                                                      Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                                      created_at google.protobuf.Timestamp
                                                                      Время создания в формате RFC3339 .
                                                                      name string
                                                                      Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                                      description string
                                                                      Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                                      labels map<string,string>
                                                                      Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                                      environment enum Environment
                                                                      Среда развертывания кластера ClickHouse.
                                                                      • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                                      • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                                        monitoring[] Monitoring
                                                                        Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                                        config ClusterConfig
                                                                        Конфигурация кластера ClickHouse.
                                                                        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: Кластер запускается.

                                                                            ListLogs

                                                                            Получает логи для указанного кластера ClickHouse.

                                                                            rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

                                                                            ListClusterLogsRequest

                                                                            Поле Описание
                                                                            cluster_id string
                                                                            Обязательное поле. Идентификатор кластера ClickHouse, для которого следует запросить логи. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                            column_filter[] string
                                                                            Столбцы из таблицы логов, которые нужно запросить. Если столбцы не указаны, записи логов возвращаются целиком.
                                                                            service_type enum ServiceType
                                                                            Тип сервиса, для которого следует запросить логи.
                                                                            • CLICKHOUSE: Логи работы ClickHouse.
                                                                              from_time google.protobuf.Timestamp
                                                                              Начало периода, для которого следует запросить логи, в формате RFC3339.
                                                                              to_time google.protobuf.Timestamp
                                                                              Конец периода, для которого следует запросить логи, в формате RFC3339.
                                                                              page_size int64
                                                                              Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                                              page_token string
                                                                              Токен страницы. Установите значение page_token равным значению поля ListClusterLogsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                              ListClusterLogsResponse

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

                                                                              LogRecord

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

                                                                              ListOperations

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

                                                                              rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                                              ListClusterOperationsRequest

                                                                              Поле Описание
                                                                              cluster_id string
                                                                              Обязательное поле. Идентификатор ресурса Cluster для ClickHouse, для которого запрашивается список операций. Максимальная длина строки в символах — 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
                                                                              Список ресурсов Operation для указанного кластера ClickHouse.
                                                                              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.

                                                                              ListBackups

                                                                              Получает список доступных резервных копий для указанного кластера ClickHouse.

                                                                              rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

                                                                              ListClusterBackupsRequest

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

                                                                              ListClusterBackupsResponse

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

                                                                              Backup

                                                                              Поле Описание
                                                                              id string
                                                                              Идентификатор резервной копии.
                                                                              folder_id string
                                                                              Идентификатор каталога, которому принадлежит резервная копия.
                                                                              created_at google.protobuf.Timestamp
                                                                              Время создания в формате RFC3339 (т. е. когда операция резервного копирования была завершена).
                                                                              source_cluster_id string
                                                                              Идентификатор кластера ClickHouse, для которого была создана резервная копия.
                                                                              source_shard_names[] string
                                                                              Имена шардов, включенных в резервную копию.
                                                                              started_at google.protobuf.Timestamp
                                                                              Время запуска операции резервного копирования.

                                                                              ListHosts

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

                                                                              rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

                                                                              ListClusterHostsRequest

                                                                              Поле Описание
                                                                              cluster_id string
                                                                              Обязательное поле. Идентификатор кластера ClickHouse. Чтобы получить идентификатор кластера ClickHouse, используйте запрос 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
                                                                              Имя хоста ClickHouse. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов.
                                                                              Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
                                                                              cluster_id string
                                                                              Идентификатор хоста ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                                              zone_id string
                                                                              Идентификатор зоны доступности, в которой находится хост ClickHouse.
                                                                              type enum Type
                                                                              Тип хоста.
                                                                              • CLICKHOUSE: Хост ClickHouse.
                                                                              • ZOOKEEPER: Хост ZooKeeper.
                                                                                resources Resources
                                                                                Ресурсы, выделенные хосту ClickHouse.
                                                                                health enum Health
                                                                                Код работоспособности хоста.
                                                                                • UNKNOWN: Состояние хоста неизвестно.
                                                                                • ALIVE: Хозяин выполняет все свои функции нормально.
                                                                                • DEAD: Хост не работает и не может выполнять свои основные функции.
                                                                                • DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
                                                                                  services[] Service
                                                                                  Сервисы, предоставляемые хостом.
                                                                                  subnet_id string
                                                                                  Идентификатор подсети, к которой принадлежит хост.
                                                                                  assign_public_ip bool
                                                                                  Флаг, показывающий статус публичного IP-адреса для этого хоста.
                                                                                  shard_name string

                                                                                  Resources

                                                                                  Поле Описание
                                                                                  resource_preset_id string
                                                                                  Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                                                  disk_size int64
                                                                                  Объем хранилища, доступного хосту, в байтах.
                                                                                  disk_type_id string
                                                                                  • network-hdd — сетевой HDD-диск;
                                                                                  • network-ssd — сетевой SSD-диск;
                                                                                  • local-ssd — локальное SSD-хранилище.

                                                                                  Service

                                                                                  Поле Описание
                                                                                  type enum Type
                                                                                  Тип сервиса, предоставляемого хостом.
                                                                                  • CLICKHOUSE: Хост — это сервер ClickHouse.
                                                                                  • ZOOKEEPER: Хост — сервер ZooKeeper.
                                                                                    health enum Health
                                                                                    Код состояния доступности сервера.
                                                                                    • UNKNOWN: Работоспособность сервера неизвестна.
                                                                                    • ALIVE: Сервер работает нормально.
                                                                                    • DEAD: Сервер отключен или не отвечает.

                                                                                      AddHosts

                                                                                      Создает новые хосты для кластера.

                                                                                      rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:AddClusterHostsMetadata
                                                                                          Operation.response:google.protobuf.Empty

                                                                                      AddClusterHostsRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse, для которого следует добавить хосты. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      host_specs[] HostSpec
                                                                                      Конфигурации для хостов ClickHouse, которые должны быть добавлены в кластер. Количество элементов должно быть больше 0.

                                                                                      HostSpec

                                                                                      Поле Описание
                                                                                      zone_id string
                                                                                      Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                                      type Host.Type
                                                                                      Обязательное поле. Тип развертываемого хоста.
                                                                                      subnet_id string
                                                                                      Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                                      assign_public_ip bool
                                                                                      • false — не назначать хосту публичный IP-адрес.
                                                                                      • true — у хоста должен быть публичный IP-адрес.
                                                                                      shard_name string
                                                                                      Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                                      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<AddClusterHostsMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                                      в случае успешного выполнения операции.

                                                                                      AddClusterHostsMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера ClickHouse, в который добавляются хосты.
                                                                                      host_names[] string
                                                                                      Имена хостов, добавляемых в кластер.

                                                                                      DeleteHosts

                                                                                      Удаляет указанные хосты кластера.

                                                                                      rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:DeleteClusterHostsMetadata
                                                                                          Operation.response:google.protobuf.Empty

                                                                                      DeleteClusterHostsRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse из которого следует удалить хосты. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      host_names[] string
                                                                                      Имена хостов, которые следует удалить. Количество элементов должно быть больше 0. Максимальная длина строки в символах для каждого значения — 253.

                                                                                      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<DeleteClusterHostsMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                                      в случае успешного выполнения операции.

                                                                                      DeleteClusterHostsMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера ClickHouse из которого следует удалить хосты.
                                                                                      host_names[] string
                                                                                      Имена удаляемых хостов.

                                                                                      GetShard

                                                                                      Возвращает указанный шард.

                                                                                      rpc GetShard (GetClusterShardRequest) returns (Shard)

                                                                                      GetClusterShardRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера, к которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List(#List). Чтобы получить имя базы данных, используйте запрос [ClusterService.List]. Максимальная длина строки в символах — 50.
                                                                                      shard_name string
                                                                                      Обязательное поле. Имя шарда, информацию о котором нужно запросить. Чтобы получить имя шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                                      Shard

                                                                                      Поле Описание
                                                                                      name string
                                                                                      Имя шарда.
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, к которому принадлежит шард.
                                                                                      config ShardConfig
                                                                                      Конфигурация шарда.

                                                                                      ShardConfig

                                                                                      Поле Описание
                                                                                      clickhouse Clickhouse
                                                                                      Конфигурация ClickHouse для шарда.

                                                                                      Clickhouse

                                                                                      Поле Описание
                                                                                      config config.ClickhouseConfigSet
                                                                                      Настройки ClickHouse для шарда.
                                                                                      resources Resources
                                                                                      Вычислительные ресурсы для шарда.
                                                                                      weight google.protobuf.Int64Value
                                                                                      Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse.

                                                                                      ListShards

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

                                                                                      rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)

                                                                                      ListClusterShardsRequest

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

                                                                                      ListClusterShardsResponse

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

                                                                                      Shard

                                                                                      Поле Описание
                                                                                      name string
                                                                                      Имя шарда.
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, к которому принадлежит шард.
                                                                                      config ShardConfig
                                                                                      Конфигурация шарда.

                                                                                      ShardConfig

                                                                                      Поле Описание
                                                                                      clickhouse Clickhouse
                                                                                      Конфигурация ClickHouse для шарда.

                                                                                      Clickhouse

                                                                                      Поле Описание
                                                                                      config config.ClickhouseConfigSet
                                                                                      Настройки ClickHouse для шарда.
                                                                                      resources Resources
                                                                                      Вычислительные ресурсы для шарда.
                                                                                      weight google.protobuf.Int64Value
                                                                                      Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse.

                                                                                      AddShard

                                                                                      Создает новый шард в указанном кластере.

                                                                                      rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:AddClusterShardMetadata
                                                                                          Operation.response:Shard

                                                                                      AddClusterShardRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse, к которому нужно добавить шард. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      shard_name string
                                                                                      Обязательное поле. Имя нового шарда. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                                                      config_spec ShardConfigSpec
                                                                                      Конфигурация нового шарда.
                                                                                      host_specs[] HostSpec
                                                                                      Конфигурации для хостов ClickHouse, которые должны быть созданы вместе с шардом. Количество элементов должно быть больше 0.

                                                                                      ShardConfigSpec

                                                                                      Поле Описание
                                                                                      clickhouse Clickhouse
                                                                                      Конфигурация ClickHouse для шарда.

                                                                                      Clickhouse

                                                                                      Поле Описание
                                                                                      config config.ClickhouseConfig
                                                                                      Настройки ClickHouse для шарда.
                                                                                      resources Resources
                                                                                      Вычислительные ресурсы для шарда.
                                                                                      weight google.protobuf.Int64Value
                                                                                      Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse.

                                                                                      HostSpec

                                                                                      Поле Описание
                                                                                      zone_id string
                                                                                      Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                                      type Host.Type
                                                                                      Обязательное поле. Тип развертываемого хоста.
                                                                                      subnet_id string
                                                                                      Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                                      assign_public_ip bool
                                                                                      • false — не назначать хосту публичный IP-адрес.
                                                                                      • true — у хоста должен быть публичный IP-адрес.
                                                                                      shard_name string
                                                                                      Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                                      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<AddClusterShardMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Shard>
                                                                                      в случае успешного выполнения операции.

                                                                                      AddClusterShardMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, в который добавляется шард.
                                                                                      shard_name string
                                                                                      Имя создаваемого шарда.

                                                                                      Shard

                                                                                      Поле Описание
                                                                                      name string
                                                                                      Имя шарда.
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, к которому принадлежит шард.
                                                                                      config ShardConfig
                                                                                      Конфигурация шарда.

                                                                                      UpdateShard

                                                                                      Изменяет указанный шард.

                                                                                      rpc UpdateShard (UpdateClusterShardRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:UpdateClusterShardMetadata
                                                                                          Operation.response:Shard

                                                                                      UpdateClusterShardRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse, которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      shard_name string
                                                                                      Обязательное поле. Имя шарда, который следует изменить. Чтобы получить имя шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                                                      update_mask google.protobuf.FieldMask
                                                                                      Маска, которая указывает, какие атрибуты шарда должны быть изменены.
                                                                                      config_spec ShardConfigSpec
                                                                                      Новая конфигурация для указанного шарда.

                                                                                      ShardConfigSpec

                                                                                      Поле Описание
                                                                                      clickhouse Clickhouse
                                                                                      Конфигурация ClickHouse для шарда.

                                                                                      Clickhouse

                                                                                      Поле Описание
                                                                                      config config.ClickhouseConfig
                                                                                      Настройки ClickHouse для шарда.
                                                                                      resources Resources
                                                                                      Вычислительные ресурсы для шарда.
                                                                                      weight google.protobuf.Int64Value
                                                                                      Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse.

                                                                                      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<UpdateClusterShardMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Shard>
                                                                                      в случае успешного выполнения операции.

                                                                                      UpdateClusterShardMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, содержащего обновляемый шард.
                                                                                      shard_name string
                                                                                      Имя обновляемого шарда.

                                                                                      Shard

                                                                                      Поле Описание
                                                                                      name string
                                                                                      Имя шарда.
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, к которому принадлежит шард.
                                                                                      config ShardConfig
                                                                                      Конфигурация шарда.

                                                                                      DeleteShard

                                                                                      Удаляет указанный шард.

                                                                                      rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:DeleteClusterShardMetadata
                                                                                          Operation.response:google.protobuf.Empty

                                                                                      DeleteClusterShardRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse, которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      shard_name string
                                                                                      Обязательное поле. Имя удаляемого шарда. Чтобы получить имя шарда, используйте запрос ClusterService.ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                                      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<DeleteClusterShardMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                                      в случае успешного выполнения операции.

                                                                                      DeleteClusterShardMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, содержащего удаляемый шард.
                                                                                      shard_name string
                                                                                      Имя удаляемого шарда.

                                                                                      CreateExternalDictionary

                                                                                      Создает внешний словарь для указанного кластера ClickHouse.

                                                                                      rpc CreateExternalDictionary (CreateClusterExternalDictionaryRequest) returns (operation.Operation)

                                                                                      Метаданные и результат операции:
                                                                                          Operation.metadata:CreateClusterExternalDictionaryMetadata
                                                                                          Operation.response:Cluster

                                                                                      CreateClusterExternalDictionaryRequest

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Обязательное поле. Идентификатор кластера ClickHouse, для которого следует создать внешний словарь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                                      external_dictionary config.ClickhouseConfig.ExternalDictionary
                                                                                      Конфигурация внешнего словаря.

                                                                                      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<CreateClusterExternalDictionaryMetadata>
                                                                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                                      в случае успешного выполнения операции.

                                                                                      CreateClusterExternalDictionaryMetadata

                                                                                      Поле Описание
                                                                                      cluster_id string
                                                                                      Идентификатор кластера, для которого создается внешний словарь.

                                                                                      Cluster

                                                                                      Поле Описание
                                                                                      id string
                                                                                      Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                                                      folder_id string
                                                                                      Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                                                      created_at google.protobuf.Timestamp
                                                                                      Время создания в формате RFC3339 .
                                                                                      name string
                                                                                      Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                                                      description string
                                                                                      Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                                                      labels map<string,string>
                                                                                      Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                                                      environment enum Environment
                                                                                      Среда развертывания кластера ClickHouse.
                                                                                      • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                                                      • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                                                        monitoring[] Monitoring
                                                                                        Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                                                        config ClusterConfig
                                                                                        Конфигурация кластера ClickHouse.
                                                                                        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: Кластер запускается.

                                                                                            DeleteExternalDictionary

                                                                                            Удаляет указанный внешний словарь.

                                                                                            rpc DeleteExternalDictionary (DeleteClusterExternalDictionaryRequest) returns (operation.Operation)

                                                                                            Метаданные и результат операции:
                                                                                                Operation.metadata:DeleteClusterExternalDictionaryMetadata
                                                                                                Operation.response:Cluster

                                                                                            DeleteClusterExternalDictionaryRequest

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

                                                                                            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<DeleteClusterExternalDictionaryMetadata>
                                                                                            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                                                                            в случае успешного выполнения операции.

                                                                                            DeleteClusterExternalDictionaryMetadata

                                                                                            Поле Описание
                                                                                            cluster_id string
                                                                                            Идентификатор кластера, для которого удаляется внешний словарь.

                                                                                            Cluster

                                                                                            Поле Описание
                                                                                            id string
                                                                                            Идентификатор кластера ClickHouse. Этот идентификатор генерирует MDB при создании.
                                                                                            folder_id string
                                                                                            Идентификатор каталога, которому принадлежит кластер ClickHouse.
                                                                                            created_at google.protobuf.Timestamp
                                                                                            Время создания в формате RFC3339 .
                                                                                            name string
                                                                                            Имя кластера ClickHouse. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                                                            description string
                                                                                            Описание кластера ClickHouse. Длина описания должна быть от 0 до 256 символов.
                                                                                            labels map<string,string>
                                                                                            Пользовательские метки для кластера ClickHouse в виде пар key:value. Максимум 64 на ресурс.
                                                                                            environment enum Environment
                                                                                            Среда развертывания кластера ClickHouse.
                                                                                            • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                                                            • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                                                              monitoring[] Monitoring
                                                                                              Описание систем мониторинга, относящихся к данному кластеру ClickHouse.
                                                                                              config ClusterConfig
                                                                                              Конфигурация кластера ClickHouse.
                                                                                              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: Кластер запускается.