Postman によるプログラムによる API アクセス
このガイドでは、Postman を使用して ClickHouse Cloud API をテストする方法を説明します。 Postman アプリケーションは Web ブラウザで利用できるほか、デスクトップアプリとしてダウンロードして利用することもできます。
アカウントを作成する
- 無料アカウントを https://www.postman.com から作成できます。
ワークスペースを作成する
- ワークスペース名と可視性レベルを設定します。
コレクションを作成する
- 画面左上のメニューで「Explore」の下にある「Import」をクリックします。
- モーダルダイアログが表示されます。
-
API アドレス「https://api.clickhouse.cloud/v1」を入力し、Enter キーを押します。
-
「Import」ボタンをクリックして「Postman Collection」を選択します。
ClickHouse Cloud API spec との連携
- 「API spec for ClickHouse Cloud」が、左側のナビゲーションの「Collections」に表示されます。
- 「API spec for ClickHouse Cloud」をクリックし、中央ペインから「Authorization」タブを選択します。
認証を設定する
- ドロップダウンメニューを開き、「Basic Auth」を選択します：
- ClickHouse Cloud の API キーを設定したときに発行されたユーザー名 (Username) とパスワード (Password) を入力します：
変数を有効にする
- Variables を使用すると、Postman 内で値を保存して再利用できるため、API テストをより簡単に行えます。
組織 ID と Service ID を設定する
- 「Collection」内で、中央ペインの「Variable」タブをクリックします（Base URL は先ほどの API インポートで設定されています）。
baseURLの下にある「Add new value」という空フィールドをクリックし、自分の組織 ID と Service ID に置き換えて入力します。
ClickHouse Cloud API の機能をテストする
「GET list of available organizations」をテストする
- 「OpenAPI spec for ClickHouse Cloud」で、フォルダー > 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 が返され、サービス情報が何も含まれていない場合は、構成が正しくありません）。
