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

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

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

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

1. Для создания ключей API и управления ими можно использовать вкладку ключей API в левом меню.

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

3. Чтобы создать ключ API, укажите имя ключа, разрешения для него и срок действия, затем нажмите Generate API Key.

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

конечные точки Query API

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

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

5. 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

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

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

​

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

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