Управление ключами API - ClickHouse Documentation

ClickHouse Cloud предоставляет API на основе OpenAPI, который позволяет программно управлять вашим аккаунтом и отдельными аспектами ваших сервисов.

В этом документе рассматривается ClickHouse Cloud API. Сведения о конечных точках API базы данных см. в разделе Cloud Endpoints API

Откройте страницу API Keys

Используйте вкладку API Keys в левом меню, чтобы создавать ключи API и управлять ими.

Начните создание ключа API

На странице API Keys сначала отобразится предложение создать ваш первый ключ API, как показано ниже. После создания первого ключа вы сможете создавать новые ключи с помощью кнопки New API Key, которая появится в правом верхнем углу.

Настройте ключ API

Укажите имя ключа, разрешения для него и срок действия.

Разрешения соответствуют предопределённым ролям ClickHouse Cloud. Роль developer имеет разрешения только для чтения для назначенных сервисов, а роль admin — полные разрешения на чтение и запись.

Эндпоинты Query APIЧтобы использовать ключи API с эндпоинтами Query API, установите для Organization Role значение Member (минимум) и предоставьте Service Role доступ к Query Endpoints.

Добавьте разрешённые IP-адреса

Чтобы ограничить круг клиентов, которые могут использовать ключ API, в разделе Allow access to this API Key выберите Specific locations. Введите IP-адрес или диапазон CIDR, например 203.0.113.1 или 203.0.113.0/24, и при необходимости добавьте дополнительные записи.Эндпоинты Query API учитывают списки разрешённых IP-адресов на уровне ключа API. Поскольку запросы проксируются из инфраструктуры ClickHouse, списки разрешённых IP-адресов на уровне сервиса не применяются. Подробности см. в разделе IP Access Control.Закончив настройку ключа, нажмите Generate API Key.

Сохраните учётные данные ключа API

На следующем экране будут показаны ваши Key ID и Key secret. Скопируйте эти значения и сохраните их в безопасном месте, например в хранилище секретов. После ухода с этого экрана они больше не будут отображаться.

Аутентифицируйте API-запросы

ClickHouse Cloud API использует HTTP Basic Authentication для проверки действительности ваших ключей API. Ниже приведён пример использования ключей API для отправки запросов в ClickHouse Cloud API с помощью curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

Управляйте существующими ключами API

Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа Key ID, разрешения, status, дату истечения срока действия и создателя. На этом экране можно редактировать имя ключа, разрешения и срок действия. Здесь же ключи можно отключать или удалять.

Удаление ключа API — необратимое действие. Любые сервисы, использующие этот ключ, немедленно потеряют доступ к ClickHouse Cloud.

Конечные точки

Сведения о конечных точках см. в справочнике API. Используйте свой ключ API и секрет API с базовым URL https://api.clickhouse.cloud/v1.

​Конечные точки

Конечные точки