Управление расширениями в Managed Service for ClickHouse®

Статья создана

Yandex Cloud

Улучшена

mmerihsesh

Обновлена 1 декабря 2025 г.

Получить список доступных расширений
Получить список установленных расширений
Получить информацию о расширении
Получить информацию об установленном в кластер расширении
Установить расширение в кластер
Обновить расширение
Удалить расширение из кластера
Пакетная установка, обновление и удаление расширений

В кластерах Managed Service for ClickHouse® доступны следующие расширения:

Расширение	Описание
CatBoost	Анализ данных с помощью моделей машинного обучения CatBoost
GeoDB	Управление геобазами: загрузка, подключение, создание собственных геобаз

Получить список доступных расширений

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы получить список всех доступных для установки расширений и их версии, выполните команду:

yc managed-clickhouse extension list

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```

Воспользуйтесь методом Extension.List и выполните запрос, например с помощью cURL:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/extensions'

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Доступные к установке расширения и их версии приведены в параметре extensions в выводе команды.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ExtensionService.List и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "folder_id": "<идентификатор_каталога>"
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ExtensionService.List

Идентификатор каталога можно запросить со списком каталогов в облаке.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Доступные к установке расширения и их версии приведены в параметре extensions в выводе команды.

Получить список установленных расширений

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить список всех установленных в кластере расширений и их версии, выполните команду:

yc managed-clickhouse cluster list-extensions <имя_или_идентификатор_кластера>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом ClusterExtension.List и выполните запрос, например с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.List и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>"
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.List

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить информацию о расширении

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить подробную информацию о расширении, выполните команду:

yc managed-clickhouse extension get <имя_расширения>

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```

Воспользуйтесь методом Extension.Get и выполните запрос, например с помощью cURL:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/extensions/<имя_расширения>'

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ExtensionService.Get и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "extension_name": "<имя_расширения>",
        "folder_id": "<идентификатор_каталога>"
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ExtensionService.Get

Идентификатор каталога можно запросить со списком каталогов в облаке.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить информацию об установленном в кластер расширении

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы получить информацию об установленном в кластер расширении, выполните команду:

yc managed-clickhouse cluster get-extension <имя_или_идентификатор_кластера> \
   --extension-name <имя_расширения>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом ClusterExtension.Get и выполните запрос, например с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions/<имя_расширения>'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.Get и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>",
        "extension_name": "<имя_расширения>"
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Get

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Установить расширение в кластер

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы установить расширение в кластер, выполните команду:

yc managed-clickhouse cluster add-extension <имя_или_идентификатор_кластера> \
   --extension-name <имя_расширения>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```

Воспользуйтесь методом ClusterExtension.Create и выполните запрос, например с помощью cURL:

curl \
  --request POST \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions'
  --data '{
            "extensionSpec": {
              "name": "<имя_расширения>"
            }
          }'

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.Create и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>",
        "extension_spec": {
            "name": "<имя_расширения>"
        }
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Create

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Обновить расширение

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы обновить установленное в кластер расширение, выполните команду:

yc managed-clickhouse cluster update-extension <имя_или_идентификатор_кластера> \
   --extension-name <имя_расширения>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```

Воспользуйтесь методом ClusterExtension.Update и выполните запрос, например с помощью cURL:

curl \
  --request PATCH \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions'
  --data '{
            "extensionSpec": {
              "name": "<имя_расширения>"
            }
          }'

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.Update и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>",
        "extension_spec": {
            "name": "<имя_расширения>"
        }
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Update

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Удалить расширение из кластера

CLI

REST API

gRPC API

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

Чтобы удалить расширение из кластера, выполните команду:

yc managed-clickhouse cluster remove-extension <имя_или_идентификатор_кластера> \
   --extension-name <имя_расширения>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом ClusterExtension.Delete и выполните запрос, например с помощью cURL:
```
curl \
  --request DELETE \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions/<имя_расширения>'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.Delete и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>",
        "extension_name": "<имя_расширения>"
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.Delete

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Пакетная установка, обновление и удаление расширений

Вы можете установить, обновить и удалить несколько расширений в одном запросе. Для этого передайте в запросе имена всех нужных расширений. Указанные в запросе расширения будут:

Установлены, если они отсутствуют в кластере.
Обновлены до последней версии, если они уже установлены в кластере.

Расширения, не указанные в запросе, будут удалены из кластера.

REST API

gRPC API

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```

Воспользуйтесь методом ClusterExtension.SetExtensions и выполните запрос, например с помощью cURL:

curl \
  --request POST \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/<идентификатор_кластера>/extensions:batchSet'
  --data '{
            "extensionSpec": [
              {
                "name": "<имя_расширения>"
              },
              {
                "name": "<имя_расширения_2>"
              },
              { ... },
              {
                "name": "<имя_расширения_N>"
              }
            ]
          }'

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterExtensionService.SetExtensions и выполните запрос, например с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>",
        "extension_specs": [
          {
              "name": "<имя_расширения>"
          },
          {
              "name": "<имя_расширения_2>"
          },
          { ... },
          {
              "name": "<имя_расширения_N>"
          }          
        ]
      }' \
  mdb.api.yandexcloud.kz:443 \
  yandex.cloud.mdb.clickhouse.v1.ClusterExtensionService.SetExtensions

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Управление расширениями в Managed Service for ClickHouse®

Получить список доступных расширенийПолучить список доступных расширений

Получить список установленных расширенийПолучить список установленных расширений

Получить информацию о расширенииПолучить информацию о расширении

Получить информацию об установленном в кластер расширенииПолучить информацию об установленном в кластер расширении

Установить расширение в кластерУстановить расширение в кластер

Обновить расширениеОбновить расширение

Удалить расширение из кластераУдалить расширение из кластера

Пакетная установка, обновление и удаление расширенийПакетная установка, обновление и удаление расширений

Была ли статья полезна?

Получить список доступных расширений

Получить список установленных расширений

Получить информацию о расширении

Получить информацию об установленном в кластер расширении

Установить расширение в кластер

Обновить расширение

Удалить расширение из кластера

Пакетная установка, обновление и удаление расширений