Show Menu
主題×

使用 Amazon Redshift API建立連 Flow Service 接器

連接 Amazon Redshift 器為測試版。 如需使用 測試版標籤連接器的詳細資訊 ,請參閱來源概觀。
Flow Service 用於收集和集中Adobe Experience Platform內不同來源的客戶資料。 該服務提供用戶介面和REST風格的API,所有支援的源都可從中連接。
本教學課程使 Flow Service 用API來引導您完成連線至的 Amazon Redshift 步驟(以下稱為「Redshift」)。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:
  • 來源 : Experience Platform 允許從各種來源接收資料,同時提供使用服務構建、標籤和增強傳入資料的 Platform 能力。
  • 沙盒 : Experience Platform 提供虛擬沙盒,可將單一執行個體分 Platform 割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。
以下各節提供您必須知道的其他資訊,以便使用 Flow Service API成功連線至。

收集必要的認證

要連接, Flow Service 必須提供 Redshift以下連接屬性:
憑證
說明
server
與您的帳戶關聯的 Redshift 伺服器。
username
與您帳戶關聯的使用 Redshift 者名稱。
password
與您帳戶關聯的 Redshift 密碼。
database
您正 Redshift 在訪問的資料庫。
有關開始使用的詳細資訊,請參 閱本Redshift文檔

讀取範例API呼叫

本教學課程提供範例API呼叫,以示範如何設定請求的格式。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱疑難排解指 南中有關如何讀取範例API呼叫的 Experience Platform 章節。

收集必要標題的值

若要呼叫API,您必 Platform 須先完成驗證教 學課程 。 完成驗證教學課程後,將提供所有 Experience Platform API呼叫中每個必要標題的值,如下所示:
  • 授權: 生產者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
中的所有資 Experience Platform源(包括屬於的資源)都 Flow Service被隔離到特定的虛擬沙盒中。 對API的所 Platform 有請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題:
  • 內容類型: application/json

查找連接規格

要建立連接, Redshift 必須在中存 Redshift 在一組連接規範 Flow Service。 連接到的第一步 Platform 是 Redshift 檢索這些規範。
API格式
每個可用源都有其唯一的連接規範集,用於描述連接器屬性(如驗證要求)。 您可以執行GET請求並使 Redshift 用查詢參數,查找連接規範。
傳送不含查詢參數的GET請求時,會傳回所有可用來源的連線規格。 您可以包含查詢, property=name=="amazon-redshift" 以取得特定的資訊 Redshift。
GET /connectionSpecs
GET /connectionSpecs?property=name=="amazon-redshift"

請求
以下請求將檢索的連接規範 Redshift。
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="amazon-redshift"' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

回應
成功的響應返回的連接規範 Redshift,包括其唯一標識符( id )。 在下個步驟中需要此ID才能建立基本連線。
{
    "items": [
        {
            "id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
            "name": "amazon-redshift",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication",
                    "type": "Basic_Authentication",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params",
                        "properties": {
                            "server": {
                                "type": "string",
                                "description": "IP address or host name of the Amazon Redshift server"
                            },
                            "username": {
                                "type": "string",
                                "description": "Name of user who has access to the database"
                            },
                            "password": {
                                "type": "string",
                                "description": "Password for the user account",
                                "format": "password"
                            },
                            "database": {
                                "type": "string",
                                "description": "Name of the Amazon Redshift database"
                            }
                        },
                        "required": [
                            "server",
                            "username",
                            "password",
                            "database"
                        ]
                    }
                }
            ]
        }
    ]
}

建立基本連接

基本連接指定源,並包含該源的憑據。 每個帳戶只需要一個基本連 Redshift 接,因為它可用於建立多個源連接器以導入不同的資料。
API格式
POST /connections

請求
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "amazon-redshift base connection",
        "description": "base connection for amazon-redshift,
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "server": "{SERVER}",
                "database": "{DATABASE}",
                "password": "{PASSWORD}",
                "username": "{USERNAME}"
            }
        },
        "connectionSpec": {
            "id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
            "version": "1.0"
        }
    }'

屬性
說明
auth.params.server
您的 Redshift 伺服器。
auth.params.database
與您的帳戶關聯的 Redshift 資料庫。
auth.params.password
與您帳戶關聯的 Redshift 密碼。
auth.params.username
與您帳戶關聯的使用 Redshift 者名稱。
connectionSpec.id
在上一步 id 中檢索 Redshift 的帳戶的連接規範。
回應
成功的響應返回新建立的基本連接的詳細資訊,包括其唯一標識符( id )。 在下一個教學課程中探索資料時,需要此ID。
{
    "id": "373e88fc-43da-4e3c-be88-fc43da3e3c0f",
    "etag": "\"1700ce7b-0000-0200-0000-5e3b405e0000\""
}

後續步驟

在本教學課程中,您已使用 Flow Service API建立基本連線,並取得連線的唯一ID值。 在下一個教程中,您可以使用此基本連接ID來學習如何使 用流服務API來探索資料庫或NoSQL系統