[Ultimate]{class="badge positive"}

Flow Service API を使用した Snowflake ベース接続の作成

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

開発者

IMPORTANT

Real-time Customer Data Platform Ultimate を購入したユーザーは、ソースカタログで Snowflake ソースを利用できます。

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

次のチュートリアルでは、[Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/) を使用して Snowflake のベース接続を作成する方法について説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
サンドボックス：Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

Platform API の使用

Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。

次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示し Snowflake す。

必要な資格情報の収集

Snowflake ソースを認証するには、次の資格情報プロパティの値を指定する必要があります。

アカウントキー認証

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2
資格情報	説明
`account`	アカウント名は、組織内のアカウントを一意に識別します。この場合、アカウントを異なる Snowflake 組織で一意に識別する必要があります。これを行うには、アカウント名の前に組織名を追加する必要があります。例：`orgname-account_name`。アカウント名について詳しくは、アカウント識別子の Snowflake ドキュメントを参照してください。
`warehouse`	Snowflake ウェアハウスは、アプリケーションのクエリ実行プロセスを管理します。各 Snowflake ウェアハウスは互いに独立しており、データを Platform に取り込む際は個別にアクセスする必要があります。
`database`	Snowflake データベースには、Platform に取り込むデータが含まれています。
`username`	Snowflake アカウントのユーザー名。
`password`	Snowflake ユーザーアカウントのパスワード。
`role`	Snowflake セッションで使用する既定のアクセス制御ロールです。役割は、指定したユーザーに既に割り当てられている既存の役割である必要があります。デフォルトの役割は `PUBLIC` です。
`connectionString`	Snowflake インスタンスへの接続に使用する接続文字列。 Snowflake の接続文字列パターンは `jdbc:snowflake://{ACCOUNT_NAME}.snowflakecomputing.com/?user={USERNAME}&password={PASSWORD}&db={DATABASE}&warehouse={WAREHOUSE}` です

キーペア認証

キーペア認証を使用するには、Snowflake ソースのアカウントを作成する際に、2048 ビットの RSA キーペアを生成してから、次の値を指定する必要があります。

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
資格情報	説明
`account`	アカウント名は、組織内のアカウントを一意に識別します。この場合、アカウントを異なる Snowflake 組織で一意に識別する必要があります。これを行うには、アカウント名の前に組織名を追加する必要があります。例：`orgname-account_name`。アカウント名について詳しくは、アカウント識別子の Snowflake ドキュメントを参照してください。
`username`	Snowflake アカウントのユーザー名。
`privateKey`	Snowflake アカウントの Base64- エンコードされた秘密鍵。暗号化された秘密鍵または暗号化されていない秘密鍵のいずれかを生成できます。暗号化された秘密鍵を使用している場合は、Experience Platformに対する認証の際に、秘密鍵のパスフレーズも指定する必要があります。
`privateKeyPassphrase`	秘密鍵のパスフレーズは、暗号化された秘密鍵を使用して認証を行う場合に使用する必要がある、追加のセキュリティレイヤーです。暗号化されていない秘密鍵を使用している場合は、パスフレーズを指定する必要はありません。
`database`	Experience Platformに取り込むデータを含む Snowflake データベース。
`warehouse`	Snowflake ウェアハウスは、アプリケーションのクエリ実行プロセスを管理します。各 Snowflake ウェアハウスは互いに独立しており、データをExperience Platformに取り込む際には個別にアクセスする必要があります。

これらの値について詳しくは、Snowflake キーペア認証ガイドを参照してください。

NOTE

Snowflake データベースからデータをExperience Platformにアンロードできるようにするには、PREVENT_UNLOAD_TO_INLINE_URL フラグを FALSE に設定する必要があります。

ベース接続の作成

ベース接続は、ソースと Platform 間の情報（ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など）を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続 ID を作成するには、/connections エンドポイントに対してPOSTリクエストを実行し、その際にリクエスト本文の一部として Snowflake 認証資格情報を指定します。

API 形式

POST /connections

ConnectionString

accordion

リクエスト

次のリクエストは、Snowflake のベース接続を作成します。

code language-shell

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Snowflake base connection",
      "description": "Snowflake base connection",
      "auth": {
          "specName": "ConnectionString",
          "params": {
              "connectionString": "jdbc:snowflake://{ACCOUNT_NAME}.snowflakecomputing.com/?user={USERNAME}&password={PASSWORD}&db={DATABASE}&warehouse={WAREHOUSE}"
          }
      },
      "connectionSpec": {
          "id": "b2e08744-4f1a-40ce-af30-7abac3e23cf3",
          "version": "1.0"
      }
  }'

table 0-row-2 1-row-2 2-row-2
プロパティ	説明
`auth.params.connectionString`	Snowflake インスタンスへの接続に使用する接続文字列。 Snowflake の接続文字列のパターンは `jdbc:snowflake://{ACCOUNT_NAME}.snowflakecomputing.com/?user={USERNAME}&password={PASSWORD}&db={DATABASE}&warehouse={WAREHOUSE}` です。
`connectionSpec.id`	Snowflake 接続仕様 ID: `b2e08744-4f1a-40ce-af30-7abac3e23cf3`。

accordion

応答

応答が成功すると、一意の接続識別子（id）を含む、新しく作成された接続が返されます。この ID は、次のチュートリアルでデータを調べるために必要です。

code language-json
`{ "id": "2fce94c1-9a93-4971-8e94-c19a93097129", "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\"" }`

暗号化された秘密鍵を使用したキーペア認証

accordion

リクエスト

code language-shell

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Snowflake base connection with encrypted private key",
      "description": "Snowflake base connection with encrypted private key",
      "auth": {
        "specName": "KeyPair Authentication",
        "params": {
            "account": "acme-snowflake123",
            "username": "acme-cj123",
            "database": "ACME_DB",
            "privateKey": "{BASE_64_ENCODED_PRIVATE_KEY}",
            "privateKeyPassphrase": "abcd1234",
            "warehouse": "COMPUTE_WH"
        }
    },
    "connectionSpec": {
        "id": "b2e08744-4f1a-40ce-af30-7abac3e23cf3",
        "version": "1.0"
    }
  }'

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2
プロパティ	説明
`auth.params.account`	Snowflake アカウントの名前。
`auth.params.username`	Snowflake アカウントに関連付けられたユーザー名。
`auth.params.database`	データの取得元となる Snowflake データベース。
`auth.params.privateKey`	Snowflake アカウントの Base64- エンコードされた暗号化された秘密鍵。
`auth.params.privateKeyPassphrase`	秘密鍵に対応するパスフレーズ。
`auth.params.warehouse`	使用している Snowflake ウェアハウス。
`connectionSpec.id`	Snowflake 接続仕様 ID: `b2e08744-4f1a-40ce-af30-7abac3e23cf3`。

accordion

応答

code language-json
`{ "id": "2fce94c1-9a93-4971-8e94-c19a93097129", "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\"" }`

暗号化されていない秘密鍵を使用したキーペア認証

accordion

リクエスト

code language-shell

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Snowflake base connection with encrypted private key",
      "description": "Snowflake base connection with encrypted private key",
      "auth": {
        "specName": "KeyPair Authentication",
        "params": {
            "account": "acme-snowflake123",
            "username": "acme-cj123",
            "database": "ACME_DB",
            "privateKey": "{BASE_64_ENCODED_PRIVATE_KEY}",
            "warehouse": "COMPUTE_WH"
        }
    },
    "connectionSpec": {
        "id": "b2e08744-4f1a-40ce-af30-7abac3e23cf3",
        "version": "1.0"
    }
  }'

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
プロパティ	説明
`auth.params.account`	Snowflake アカウントの名前。
`auth.params.username`	Snowflake アカウントに関連付けられたユーザー名。
`auth.params.database`	データの取得元となる Snowflake データベース。
`auth.params.privateKey`	Snowflake アカウントの Base64- エンコードされた暗号化されていない秘密鍵。
`auth.params.warehouse`	使用している Snowflake ウェアハウス。
`connectionSpec.id`	Snowflake 接続仕様 ID: `b2e08744-4f1a-40ce-af30-7abac3e23cf3`。

accordion

応答

code language-json
`{ "id": "2fce94c1-9a93-4971-8e94-c19a93097129", "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\"" }`

このチュートリアルでは、Flow Service API を使用して Snowflake ベース接続を作成しました。このベース接続 ID は、次のチュートリアルで使用できます。

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089