APIキーの管理

ClickHouse Cloudは、アカウントおよびサービスの側面を自動的に管理するためのAPIをOpenAPIを使用して提供します。

注記

この文書はClickHouse Cloud APIについて説明しています。データベースの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. ClickHouse Cloud APIでは、APIキーの有効性を確認するためにHTTP Basic Authenticationを使用します。以下の例は、curlを使用してClickHouse Cloud APIにリクエストを送信する際にAPIキーを使用する方法を示しています。

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

6. API Keysページに戻ると、キー名、キーIDの最後の4文字、権限、ステータス、有効期限、作成者が表示されます。この画面からキー名、権限、有効期限を編集できます。この画面からキーを無効にしたり削除したりすることもできます。

注記

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

エンドポイント

エンドポイントの詳細については、APIリファレンスを参照してください。
ベースURL https://api.clickhouse.cloud/v1 とともにAPIキーとAPIシークレットを使用してください。