Управление ключами API
ClickHouse Cloud предоставляет API с использованием OpenAPI, который позволяет вам программно управлять вашей учетной записью и аспектами ваших услуг.
примечание
Этот документ охватывает API ClickHouse Cloud. Для конечных точек API базы данных смотрите Cloud Endpoints API
- Вы можете использовать вкладку API Keys в левом меню для создания и управления вашими ключами API.
- Страница API Keys изначально отобразит подсказку для создания вашего первого ключа API, как показано ниже. После создания вашего первого ключа вы можете создавать новые ключи, используя кнопку
New API Key, которая появится в правом верхнем углу.
- Чтобы создать ключ API, укажите имя ключа, разрешения для ключа и время истечения, затем нажмите
Generate API Key.
примечание
Разрешения соответствуют предопределенным ролям ClickHouse Cloud. Роль разработчика имеет разрешения только на чтение, а роль администратора имеет полные разрешения на чтение и запись.
- На следующем экране будут отображены ваш Key ID и ключевой секрет. Скопируйте эти значения и сохраните их в безопасном месте, например, в хранилище. Значения не будут отображены после того, как вы покинете этот экран.
- API ClickHouse Cloud использует HTTP Basic Authentication для проверки действительности ваших ключей API. Вот пример того, как использовать ваши ключи API для отправки запросов к API ClickHouse Cloud с использованием
curl:
- Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа Key ID, разрешения, статус, дату истечения и создателя. Вы можете редактировать имя ключа, разрешения и время истечения с этого экрана. Ключи также могут быть отключены или удалены с этого экрана.
примечание
Удаление ключа API — это необратимое действие. Любые услуги, использующие ключ, немедленно потеряют доступ к ClickHouse Cloud.
Endpoints
Документация по конечным точкам здесь. Используйте ваш API Key и API Secret с базовым URL https://api.clickhouse.cloud/v1.