メインコンテンツまでスキップ
メインコンテンツまでスキップ

APIキーの管理

ClickHouse Cloudは、アカウント及びサービスの管理をプログラム的に行うためのOpenAPIを利用するAPIを提供しています。

注記

このドキュメントはClickHouse Cloud APIを扱います。データベースAPIエンドポイントについては、Cloud Endpoints APIをご覧ください。

  1. 左側のメニューのAPI Keysタブを使用して、APIキーの作成と管理を行うことができます。
  1. API Keysページには、最初のAPIキーを作成するためのプロンプトが表示されます。これは以下のようになります。最初のキーが作成された後は、右上隅に表示されるNew API Keyボタンを使用して新しいキーを作成できます。
  1. APIキーを作成するには、キー名、キーの権限、および有効期限を指定し、Generate API Keyをクリックします。

注記

権限はClickHouse Cloudの定義済みロールに準じています。開発者ロールには読み取り専用の権限があり、管理者ロールには完全な読み取りおよび書き込み権限があります。

  1. 次の画面には、キーIDとキーシークレットが表示されます。これらの値をコピーし、安全な場所（例えば、金庫）に保存してください。この画面を離れると、値は表示されなくなります。
  1. ClickHouse Cloud APIは、HTTP Basic Authenticationを使用してAPIキーの有効性を確認します。以下は、curlを使用してClickHouse Cloud APIにリクエストを送信する方法の例です：
  1. API Keysページに戻ると、キー名、キーIDの最後の4文字、権限、ステータス、有効期限、および作成者が表示されます。この画面からキー名、権限、および有効期限を編集することができます。また、この画面からキーを無効にしたり削除したりすることができます。

注記

APIキーを削除することは永久的な操作です。キーを使用しているサービスは、直ちにClickHouse Cloudへのアクセスを失います。

エンドポイント​

エンドポイントのドキュメントはこちらです。APIキーとAPIシークレットを使用して、ベースURL https://api.clickhouse.cloud/v1 を使用してください。