Управление ключами 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 и Key secret. Скопируйте эти значения и сохраните их в безопасном месте, таком как сейф. Значения не будут отображаться после того, как вы покинете этот экран.
- API ClickHouse Cloud использует HTTP Basic Authentication для проверки действительности ваших ключей API. Вот пример того, как использовать ваши ключи API для отправки запросов к API ClickHouse Cloud с помощью
curl:
- Вернувшись на страницу API Keys, вы увидите имя ключа, последние четыре символа Key ID, права, статус, дату истечения и создателя. Вы можете редактировать имя ключа, права и срок действия с этого экрана. Ключи также могут быть отключены или удалены с этого экрана.
примечание
Удаление ключа API является необратимым действием. Все услуги, использующие ключ, немедленно потеряют доступ к ClickHouse Cloud.
Конечные точки
Документация конечных точек находится здесь. Используйте ваш API Key и API Secret с базовым URL https://api.clickhouse.cloud/v1.