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

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

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

примечание

Этот документ охватывает API ClickHouse Cloud. Для конечных точек 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. Роль разработчика имеет только права на чтение для назначенных услуг, а роль администратора имеет полные права на чтение и запись.

Форма создания ключа API
  1. На следующем экране будут отображены ваш идентификатор ключа и секретный ключ. Скопируйте эти значения и сохраните их в безопасном месте, таком как хранилище. Значения не будут отображаться после того, как вы покинете этот экран.
Детали ключа API
  1. API ClickHouse Cloud использует HTTP Basic Authentication для проверки действительности ваших ключей API. Вот пример использования ваших ключей API для отправки запросов к API ClickHouse Cloud с помощью curl:
$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
  1. Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа идентификатора ключа, права доступа, статус, дату окончания действия и создателя. Вы можете редактировать имя ключа, права доступа и срок действия с этого экрана. Ключи также могут быть отключены или удалены с этого экрана.

примечание

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

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

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

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