Перейти к основному содержанию
Перейти к основному содержанию

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

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

Примечание

В этом документе рассматривается ClickHouse Cloud API. Об API-эндпойнтах базы данных см. Cloud Endpoints API

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

Примечание

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

Запрос к конечным точкам API

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

Форма создания ключа API
  1. На следующем экране будут отображены ваш Key ID и секрет ключа (Key secret). Скопируйте эти значения и сохраните их в надежном месте, например в хранилище секретов. После перехода с этого экрана значения больше не будут отображаться.
Сведения о ключе API
  1. 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
  1. Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа идентификатора ключа (Key ID), права доступа, статус, дату истечения срока действия и создателя. На этом экране вы можете изменить имя ключа, права доступа и срок действия. Здесь же ключи можно отключать или удалять.

Примечание

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

Страница управления API-ключами

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

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