API キーの管理 - ClickHouse Documentation

ClickHouse Cloud では OpenAPI を利用する API が提供されており、アカウントやサービスの各種項目をプログラムから管理できます。

このドキュメントでは ClickHouse Cloud API について説明します。データベース API エンドポイントについては、Cloud Endpoints API を参照してください。

API キーのページを開く

左側のメニューにある API Keys タブを使用して、API キーを作成および管理できます。

API キーの作成を開始する

API Keys ページには、最初は下図のように最初の API キーを作成するための案内が表示されます。最初のキーを作成すると、以降は右上に表示される New API Key ボタンから新しいキーを作成できます。

API キーを設定する

キー名、キーの権限、有効期限を指定します。

権限は ClickHouse Cloud の事前定義ロールに対応しています。developer ロールには割り当てられたサービスに対する読み取り専用権限があり、admin ロールには読み取りと書き込みの両方に対する完全な権限があります。

クエリ API エンドポイントAPI キーをクエリ API エンドポイントで使用するには、Organization Role を Member (最低でも) に設定し、Service Role に Query Endpoints へのアクセスを付与してください。

許可する IP アドレスを追加する

API キーを使用できるクライアントを制限するには、Allow access to this API Key セクションで Specific locations を選択します。203.0.113.1 や 203.0.113.0/24 などの IP アドレスまたは CIDR 範囲を入力し、必要に応じて追加のエントリを加えます。クエリ API エンドポイントでは、API キーレベルの IP 許可リストが適用されます。リクエストは ClickHouse のインフラストラクチャ内からプロキシされるため、サービスレベルの IP 許可リストは適用されません。詳しくは IP Access Control を参照してください。キーの設定が完了したら、Generate API Key をクリックします。

API キーの認証情報を保存する

次の画面に Key ID と Key secret が表示されます。これらの値をコピーし、保管庫などの安全な場所に保存してください。この画面を離れると、これらの値は再表示されません。

API リクエストを認証する

ClickHouse Cloud API では、API キーの有効性を確認するために HTTP Basic Authentication を使用します。以下は、API キーを使用して curl で ClickHouse Cloud API にリクエストを送信する例です。

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

既存の API キーを管理する

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

API キーの削除は元に戻せない操作です。そのキーを使用しているサービスは、ただちに ClickHouse Cloud へのアクセスを失います。

エンドポイント

エンドポイントの詳細については、API リファレンスを参照してください。 base URL https://api.clickhouse.cloud/v1 を使用し、API キーと API Secret を指定します。

​エンドポイント

エンドポイント