メインコンテンツへスキップ
メインコンテンツへスキップ

API キーの管理

ClickHouse Cloud は OpenAPI を利用した API を提供しており、アカウントおよびサービスをプログラムから管理できます。

注記

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

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

注記

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

Query API Endpoints

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

API キー作成フォーム
  1. 次の画面に Key ID と Key secret が表示されます。これらの値をコピーし、Vault などの安全な場所に保管してください。この画面を離れた後は値は再表示されません。
API キー詳細
  1. ClickHouse Cloud API は HTTP Basic Authentication を使用して API キーの有効性を検証します。以下は、curl を使用して ClickHouse Cloud API にリクエストを送信する際の API キーの使用例です。
$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
  1. API Keys ページに戻ると、キー名、Key ID の末尾 4 文字、権限、ステータス、有効期限、作成者が表示されます。この画面から、キー名、権限、有効期限を編集できます。キーはこの画面から無効化または削除することもできます。

注記

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

API キー管理ページ

エンドポイント​

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