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

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

примечание

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

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

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

3. Для создания ключа API укажите имя ключа, права для ключа и время истечения, затем нажмите Generate API Key.

примечание

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

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

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

6. Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа ID ключа, права, статус, дату истечения и создателя. Вы можете редактировать имя ключа, права и дату истечения с этого экрана. Ключи также могут быть отключены или удалены с этого экрана.

примечание

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

Endpoints

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