Snowflake REST APIs チュートリアルの共通設定

概要

このトピックでは、このドキュメントで提供するすべてのSnowflake REST APIs のチュートリアルで必要な共通設定方法を説明します。

Snowflake REST APIs の概要

セットアップを始める前に、 Snowflake REST APIs をご覧ください。

Snowflake REST APIs は、対応する APIs を通じて以下のリソースをサポートしています。APIs は CREATE OR ALTER 該当する資源のオペレーションをサポートしteiます。

APIs とそのエンドポイントについての参考情報は、 Snowflake REST APIs リファレンス をご参照ください。

Tip

Pythonアプリケーションを書きたい場合は、 Snowflake Python APIs を使用してSnowflakeオブジェクトを管理することができます。詳細については、 Snowflake Python APIs: PythonによるSnowflakeオブジェクトの管理 をご参照ください。

Snowflake REST APIs コレクションのインポート

このチュートリアルでは、PostmanからSnowflake REST APIs コレクションをインポートする手順を説明します。

  1. Gitリポジトリ から API コレクションをフォルダにダウンロードします。

    ../../../_images/api-collections-git.png
  2. Postmanアプリケーションを開き、必要であればアカウントを作成します。

  3. Postmanで、目的のワークスペースを開きます。

    ../../../_images/postman-workspace.png
  4. Import を選択します。

    ../../../_images/postman-import-workspace.png
  5. folders を選択します。

    ../../../_images/postman-download-collections.png
  6. ダイアログで、コレクションを抽出したフォルダを選択し、 Open を選択します。

    ../../../_images/postman-import-elements.png
  7. すべての項目が選択されていることを確認し、 Import を選択します。

    左のパネルに図のようにコレクションが表示されているはずです。

    ../../../_images/postman-verify-import.png

Postmanでベアラートークンを指定する

REST リクエストは、リクエストを認証するためにリクエストヘッダーに JWT トークンを必要とします。JWT トークンをお持ちでない場合は、 JWT トークンの生成 をご参照ください。

Postmanでは、図のように JWT トークンを bearerToken ヘッダープロパティにコピーできます。

../../../_images/postman-bearer-token.png

次に、各リクエストヘッダーで x-snowflake-authorization-token-type キーを KEYPAIR_JWT に設定します。

../../../_images/postman-set-header.png

注釈

チュートリアル 前提条件 で述べたように、 AUTHENTICATION POLICY を定義する必要があります。 { "code": "390202", "message": "Authentication attempt rejected by the current authentication policy." } のようなエラーメッセージが表示された場合は、次の SQL コマンドを実行してポリシーを定義できます。

SHOW AUTHENTICATION POLICIES; alter AUTHENTICATION POLICY <your authentication policy> set AUTHENTICATION_METHODS = ('KEYPAIR', 'PASSWORD', 'OAUTH');
Copy

Postman環境に環境変数を設定する

Postmanの環境で環境変数を設定できます。これらの変数をPostmanで使うには、{{variable_name}} の形式にします。

すべてのエンドポイント URLs は:codenowrap:baseURL で始まり、Snowflake アカウントを識別します。baseURL には形式があります。<account_locator>.snowflakecomputing.com<account_locator> があなたのSnowflakeアカウント名です。

Postmanで:codenowrap:baseURL 変数や他の変数を設定するには、各パラメーターを有効にして、図のように値を設定します。

../../../_images/postman-env-vars.png

設定した値ごとに、 Save を選択して新しい値を保存する必要があります。

次の内容

おめでとうございます。このチュートリアルでは、 Snowflake REST APIs を使用して、Snowflake データベース、スキーマ、およびテーブルリソースを管理するための基礎を学びました。

概要

その過程で、あなたは以下のタスクを完了しました。

  • Snowflake REST APIs コレクションをインポートする。

  • Postmanでベアラートークンを指定する。

  • Postman環境に環境変数を設定する。

次のチュートリアル

次に、 チュートリアル 1: データベース、スキーマ、テーブルの作成と管理 に進み、Snowflake データベース、スキーマ、およびテーブルを作成および管理する方法を説明します。