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