クエリ API エンドポイント

保存クエリから REST API エンドポイントを簡単に作成

対話型のデータ駆動アプリケーションを構築するには、高速なデータベース、適切に構造化されたデータ、最適化されたクエリだけでは十分ではありません。 フロントエンドやマイクロサービスでも、それらのクエリが返すデータを簡単に利用できる手段が必要です。できれば、適切に構造化された API を介して利用できるのが望ましいでしょう。

クエリ API エンドポイント 機能を使用すると、ClickHouse Cloud console に保存された任意の SQL クエリから API エンドポイントを直接作成できます。 これにより、ネイティブドライバーを使って ClickHouse Cloud サービスに接続しなくても、HTTP 経由で API エンドポイントにアクセスして保存済みクエリを実行できます。

​

IP アクセス制御

クエリ API エンドポイントでは、API キー単位の IP 許可リストが適用されます。SQL Console と同様に、クエリ API エンドポイントは ClickHouse のインフラストラクチャ内部からリクエストをプロキシするため、サービスレベルの IP 許可リスト設定は適用されません。

クエリ API エンドポイントを呼び出せるクライアントを制限するには、次の手順に従います。

1. ​

   API キーの設定を開く

   1. ClickHouse Cloud Console → Organization → API Keys に移動します

   2. クエリ API エンドポイントで使用する API キーの横にある Edit をクリックします
2. ​

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

   1. Allow access to this API Key セクションで、Specific locations を選択します
   2. IP アドレスまたは CIDR 範囲 (例: 203.0.113.1 または 203.0.113.0/24) を入力します
   3. 必要に応じて複数のエントリを追加します

   クエリ API エンドポイントを作成するには、Admin Console ロールと、適切な権限を持つ API キーが必要です。

ガイド

クエリ API エンドポイントを数ステップで簡単に設定する方法については、クエリ API エンドポイント ガイドを参照してください