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

APIキーの管理

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

注記

このドキュメントは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. 次の画面には、Key IDとKey secretが表示されます。これらの値をコピーして、安全な場所に保存してください（たとえば、ボールトなど）。この画面から離れると、値は再表示されません。
  1. ClickHouse Cloud APIは、HTTP Basic Authenticationを使用してAPIキーの有効性を確認します。以下は、curlを使用してClickHouse Cloud APIにリクエストを送信する方法の例です：
  1. API Keysページに戻ると、キー名、Key IDの最後の4文字、権限、ステータス、有効期限、作成者が表示されます。この画面からキー名、権限、有効期限を編集することができます。また、ここからキーを無効にしたり削除したりすることも可能です。

注記

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

エンドポイント​

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