ClusterService
- Вызовы ClusterService
- Get
- List
- Create
- Update
- Delete
- Start
- Stop
- Move
- AddZookeeper
- Backup
- Restore
- ListLogs
- StreamLogs
- ListOperations
- ListBackups
- ListHosts
- AddHosts
- DeleteHosts
- GetShard
- ListShards
- AddShard
- UpdateShard
- DeleteShard
- GetShardGroup
- ListShardGroups
- CreateShardGroup
- UpdateShardGroup
- DeleteShardGroup
- CreateExternalDictionary
- DeleteExternalDictionary
Набор методов для управления кластерами 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. |
StreamLogs | То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов. |
ListOperations | Получает список ресурсов Operation для указанного кластера. |
ListBackups | Получает список доступных резервных копий для указанного кластера ClickHouse. |
ListHosts | Получает список хостов для указанного кластера. |
AddHosts | Создает новые хосты для кластера. |
DeleteHosts | Удаляет указанные хосты кластера. |
GetShard | Возвращает указанный шард. |
ListShards | Получает список шардов, принадлежащих указанному кластеру. |
AddShard | Создает новый шард в указанном кластере. |
UpdateShard | Изменяет указанный шард. |
DeleteShard | Удаляет указанный шард. |
GetShardGroup | Возвращает указанную группу шардов. |
ListShardGroups | Получает список групп шардов, принадлежащих указанному кластеру. |
CreateShardGroup | Создает новую группу шардов в указанном кластере. |
UpdateShardGroup | Изменяет указанную группу шардов. |
DeleteShardGroup | Удаляет указанную группу шардов. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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
|
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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_-]* . |
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения ClickHouse. |
clickhouse | Clickhouse Конфигурация и ресурсы для сервера ClickHouse. |
zookeeper | Zookeeper Конфигурация и ресурсы для сервера ZooKeeper. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа для внешних сервисов. Если вы хотите, чтобы определенный сервис получил доступ к кластеру ClickHouse — задайте необходимые значения в этой политике. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfig Конфигурация для сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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 |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 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
|
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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_-]* . |
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения ClickHouse. |
clickhouse | Clickhouse Конфигурация и ресурсы для сервера ClickHouse. |
zookeeper | Zookeeper Конфигурация и ресурсы для сервера ZooKeeper. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа для внешних сервисов. Если вы хотите, чтобы определенный сервис получил доступ к кластеру ClickHouse — задайте необходимые значения в этой политике. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfig Конфигурация для сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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
|
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
|
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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. |
folder_id | string Идентификатор каталога, в котором нужно создать кластер ClickHouse. Максимальная длина строки в символах — 50. |
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения ClickHouse. |
clickhouse | Clickhouse Конфигурация и ресурсы для сервера ClickHouse. |
zookeeper | Zookeeper Конфигурация и ресурсы для сервера ZooKeeper. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа для внешних сервисов. Если вы хотите, чтобы определенный сервис получил доступ к кластеру ClickHouse — задайте необходимые значения в этой политике. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfig Конфигурация для сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса ResourcePresetService.List. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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
|
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
ListLogs
Получает логи для указанного кластера ClickHouse.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, для которого следует запросить логи. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы из таблицы логов, которые нужно запросить. Если столбцы не указаны, записи логов возвращаются целиком. |
service_type | enum ServiceType Тип сервиса, для которого следует запросить логи.
|
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 для перебора страниц результатов. Это значение взаимозаменяемо с StreamLogRecord.next_record_token из метода StreamLogs. |
LogRecord
Поле | Описание |
---|---|
timestamp | google.protobuf.Timestamp Отметка времени для записи журнала в RFC3339 текстовом формате. |
message | map<string,string> Содержимое записи в логе. |
StreamLogs
То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов. Допускается использовать семантику 'tail-f' при работе с потоком логов.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Обязательное поле. Идентификатор кластера ClickHouse. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы, которые нужно запросить из лога. |
service_type | enum ServiceType
|
from_time | google.protobuf.Timestamp Временная метка, начиная с которой следует запросить логи. |
to_time | google.protobuf.Timestamp Временная метка, до которой следует запросить логи. Если значение этого поля не задано, то будут отправлены все существующие записи в логе, а затем и новые по мере их появления. В сущности, это эквивалентно семантике tail -f . |
record_token | string Токен записи. Задайте значение record_token равным значению StreamLogRecord.next_record_token, возвращенному предыдущим запросом StreamLogs, чтобы продолжить стриминг со следующей записи в логе. Максимальная длина строки в символах — 100. |
StreamLogRecord
Поле | Описание |
---|---|
record | LogRecord Одна из запрошенных записей в логе. |
next_record_token | string Этот токен позволяет продолжить работу с потоком логов, начиная с этой записи. Чтобы продолжить работу с потоком, укажите значение next_record_token в качестве значения параметра StreamClusterLogsRequest.record_token в следующем запросе StreamLogs. Это значение взаимозаменяемо с ListClusterLogsResponse.next_page_token из метода ListLogs. |
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 Тип хоста.
|
resources | Resources Ресурсы, выделенные хосту ClickHouse. |
health | enum Health Код работоспособности хоста.
|
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
|
Service
Поле | Описание |
---|---|
type | enum Type Тип сервиса, предоставляемого хостом.
|
health | enum Health Код состояния доступности сервера.
|
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
|
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
|
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 Конфигурация шарда. |
ShardConfig
Поле | Описание |
---|---|
clickhouse | Clickhouse Конфигурация ClickHouse для шарда. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Настройки ClickHouse для шарда. |
resources | Resources Вычислительные ресурсы для шарда. |
weight | google.protobuf.Int64Value Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse. |
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 Конфигурация шарда. |
ShardConfig
Поле | Описание |
---|---|
clickhouse | Clickhouse Конфигурация ClickHouse для шарда. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Настройки ClickHouse для шарда. |
resources | Resources Вычислительные ресурсы для шарда. |
weight | google.protobuf.Int64Value Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse. |
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 Имя удаляемого шарда. |
GetShardGroup
Возвращает указанную группу шардов.
rpc GetShardGroup (GetClusterShardGroupRequest) returns (ShardGroup)
GetClusterShardGroupRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера, к которому принадлежит группа шардов. Максимальная длина строки в символах — 50. |
shard_group_name | string Обязательное поле. Имя группы шардов, информацию о которой нужно запросить. Чтобы получить имя группы шардов, используйте запрос ClusterService.ListShardGroups. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
ShardGroup
Поле | Описание |
---|---|
name | string Имя группы шардов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа шардов. |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | string Список имен шардов, содержащихся в группе шардов. |
ListShardGroups
Получает список групп шардов, принадлежащих указанному кластеру.
rpc ListShardGroups (ListClusterShardGroupsRequest) returns (ListClusterShardGroupsResponse)
ListClusterShardGroupsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера, к которому принадлежит группа шардов. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListClusterShardGroupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterShardGroupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListClusterShardGroupsResponse
Поле | Описание |
---|---|
shard_groups[] | ShardGroup Список групп шардов кластера ClickHouse. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterShardGroupsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterShardGroupsRequest.page_token в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
ShardGroup
Поле | Описание |
---|---|
name | string Имя группы шардов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа шардов. |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | string Список имен шардов, содержащихся в группе шардов. |
CreateShardGroup
Создает новую группу шардов в указанном кластере.
rpc CreateShardGroup (CreateClusterShardGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateClusterShardGroupMetadata
Operation.response:ShardGroup
CreateClusterShardGroupRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, в который нужно добавить группу шардов. Чтобы получить идентификатор кластера ClickHouse, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
shard_group_name | string Обязательное поле. Имя для новой группы шардов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | 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<CreateClusterShardGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<ShardGroup> в случае успешного выполнения операции. |
CreateClusterShardGroupMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, в который нужно добавить группу шардов. |
shard_group_name | string Имя для новой группы шардов. |
ShardGroup
Поле | Описание |
---|---|
name | string Имя группы шардов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа шардов. |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | string Список имен шардов, содержащихся в группе шардов. |
UpdateShardGroup
Изменяет указанную группу шардов.
rpc UpdateShardGroup (UpdateClusterShardGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateClusterShardGroupMetadata
Operation.response:ShardGroup
UpdateClusterShardGroupRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера, содержащего обновляемую группу шардов. Максимальная длина строки в символах — 50. |
shard_group_name | string Обязательное поле. Имя группы шардов, которую следует изменить. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask Маска, которая указывает, какие атрибуты группы шардов должны быть изменены. |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | 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<UpdateClusterShardGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<ShardGroup> в случае успешного выполнения операции. |
UpdateClusterShardGroupMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера, содержащего обновляемую группу шардов. |
shard_group_name | string Имя группы шардов, которую следует изменить. |
ShardGroup
Поле | Описание |
---|---|
name | string Имя группы шардов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа шардов. |
description | string Описание группы шардов кластера ClickHouse. Длина описания должна быть от 0 до 256 символов. |
shard_names[] | string Список имен шардов, содержащихся в группе шардов. |
DeleteShardGroup
Удаляет указанную группу шардов.
rpc DeleteShardGroup (DeleteClusterShardGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterShardGroupMetadata
Operation.response:google.protobuf.Empty
DeleteClusterShardGroupRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, которому принадлежит группа шардов. Максимальная длина строки в символах — 50. |
shard_group_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<DeleteClusterShardGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteClusterShardGroupMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, которому принадлежит группа шардов. |
shard_group_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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |
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.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру ClickHouse. |
config | ClusterConfig Конфигурация кластера ClickHouse. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
service_account_id | string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage. |
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. |
access | Access Политика доступа для внешних сервисов. |
Clickhouse
Поле | Описание |
---|---|
config | config.ClickhouseConfigSet Параметры конфигурации сервера ClickHouse. |
resources | Resources Ресурсы, выделенные хостам ClickHouse. |
Zookeeper
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные хостам ZooKeeper. |
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить экспорт данных из кластера в Yandex DataLens. |
web_sql | bool Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления. |
metrika | bool Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако. |
serverless | bool Разрешить доступ к кластеру для Serverless. |