Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Postman を使用した API へのプログラムアクセス

View as MarkdownEdit this pageReport an issueSet up docs MCP

このガイドでは、Postman を使って ClickHouse Cloud API をテストする方法を紹介します。 Postman アプリケーションは、Web ブラウザで利用することも、デスクトップ版をダウンロードして利用することもできます。

アカウントを作成する

Postman サイト

ワークスペースを作成する

  • ワークスペースに名前を付け、公開範囲を設定します。
ワークスペースを作成する

コレクションを作成する

  • 左上のメニューで、"Explore" の下にある "Import" をクリックします:
Explore > Import
  • モーダルウィンドウが表示されます:
API URL入力

  • API アドレス "https://api.clickhouse.cloud/v1" を入力して、'Enter' キーを押します:

  • "Import" ボタンをクリックして、"Postman Collection" を選択します:

コレクション > Import

ClickHouse Cloud API仕様を使用する

  • これで、「Collections」 (左側のナビゲーション) 内に「API spec for ClickHouse Cloud」が表示されます。
APIをインポートする
  • 「API spec for ClickHouse Cloud」をクリックします。中央のペインで「Authorization」タブを選択します。
インポート完了

認証を設定

  • ドロップダウンメニューを開き、「Basic Auth」を選択します。
Basic auth
  • ClickHouse Cloud API キーの設定時に受け取った Username と Password を入力します。
認証情報

変数を有効にする

  • Variables を使用すると、Postman で値を保存して再利用できるため、API テストをより簡単に行えます。

組織 ID とサービス ID を設定する

  • 「Collection」内で、中央ペインの「Variable」タブをクリックします (Base URL は先ほどの API インポートで設定されています) :
  • baseURL の下にある空欄の「Add new value」をクリックし、組織 ID とサービス ID に置き換えます:
組織 ID とサービス ID

ClickHouse Cloud API の機能をテストする

「利用可能な組織の一覧を取得する GET」をテストする

  • 「ClickHouse Cloud の OpenAPI spec」で、フォルダ > V1 > organizations を展開します
  • 「GET list of available organizations」をクリックし、右側の青い「Send」ボタンを押します。
組織の取得をテストする
  • 返された結果には、"status": 200 とともに組織の詳細が表示されるはずです。 (組織情報が表示されず、"status": 400 が返される場合は、設定が正しくありません)。
ステータス

「GET organizational details」をテストする

  • organizationid フォルダーで「GET organizational details」に移動します。
  • 中央フレームの Params メニューでは、organizationid が必要です。
組織の詳細の取得をテスト
  • この値を、中かっこ付きの orgid、{{orgid}} に変更します (この値を前の手順で設定していれば、その値を含むメニューが表示されます) 。
テストを送信
  • 「Save」ボタンを押した後、画面右上の青い「Send」ボタンを押します。
戻り値
  • 返された結果には、"status": 200 とともに組織の詳細が表示されるはずです。 (組織情報が表示されず "status": 400 が返る場合は、設定が正しくありません) 。

「GET service details」をテストする

  • 「GET service details」をクリックします
  • organizationid と serviceid の値を、それぞれ {{orgid}} と {{serviceid}} に編集します。
  • 「Save」を押してから、右側の青い「Send」ボタンを押します。
サービスの一覧
  • 返された結果には、"status": 200 とともに、サービスの一覧とその詳細が表示されるはずです。(サービス情報がなく "status" 400 が返される場合は、設定が正しくありません。)
Navigation