API來源的私人連結支援
您可以使用私人連結功能來建立Adobe Experience Platform來源要連線的私人端點。 使用私人IP位址將您的來源安全地連線到虛擬網路,消除對公共IP的需求,並減少您的攻擊面。 不需要複雜的防火牆或網路位址轉譯組態,同時確保資料流量僅能到達核准的服務,藉此簡化網路設定。
請閱讀本指南,瞭解如何使用API來建立和使用私有端點。
私人連結支援的授權使用權益
來源中私人連結支援的授權使用權益量度如下:
- 客戶有權透過支援的來源(Azure Blob Storage、ADLS Gen2和Azure File Storage),跨所有沙箱和組織每年進行最多2 TB的資料傳輸。
- 每個組織最多可以有10個端點用於所有生產沙箱。
- 每個組織最多可以為所有開發沙箱擁有1個端點。
快速入門
本指南需要您深入瞭解下列Experience Platform元件:
使用平台API
如需如何成功呼叫Platform API的詳細資訊,請參閱Platform API快速入門的指南。
建立私人端點 create-private-endpoint
若要建立私用端點,請向/privateEndpoints
發出POST要求。
API格式
POST /privateEndpoints
要求
以下請求會建立私有端點:
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
屬性 | 說明 |
name |
您的私人端點的名稱。 |
subscriptionId |
與您的Azure訂閱相關聯的識別碼。 如需詳細資訊,請參閱Azure的指南,從 Azure Portal擷取您的訂閱和租使用者ID。 |
resourceGroupName |
Azure上資源群組的名稱。 資源群組包含Azure解決方案的相關資源。 如需詳細資訊,請閱讀Azure管理資源群組的指南。 |
resourceName |
資源的名稱。 在Azure中,資源是指虛擬機器器、網頁應用程式和資料庫等執行個體。 如需詳細資訊,請閱讀Azure上的指南,瞭解 Azure 資源管理員。 |
connectionSpec.id |
您使用之來源的連線規格ID。 |
connectionSpec.version |
您正在使用的連線規格ID版本。 |
回應
成功的回應會傳回以下內容:
code language-json |
---|
|
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 8-row-2 | |
---|---|
屬性 | 說明 |
id |
您新建立的私人端點的識別碼。 |
name |
您的私人端點的名稱。 |
subscriptionId |
與您的Azure訂閱相關聯的識別碼。 如需詳細資訊,請參閱Azure的指南,從 Azure Portal擷取您的訂閱和租使用者ID。 |
resourceGroupName |
Azure上資源群組的名稱。 資源群組包含Azure解決方案的相關資源。 如需詳細資訊,請閱讀Azure管理資源群組的指南。 |
resourceName |
資源的名稱。 在Azure中,資源是指虛擬機器器、網頁應用程式和資料庫等執行個體。 如需詳細資訊,請閱讀Azure上的指南,瞭解 Azure 資源管理員。 |
connectionSpec.id |
您使用之來源的連線規格ID。 |
connectionSpec.version |
您正在使用的連線規格ID版本。 |
state |
您的私人端點的目前狀態。 有效狀態包括:
|
擷取私人端點的清單 retrieve-private-endpoints
若要從您組織中的指定沙箱擷取私人端點清單,請向/privateEndpoints
發出GET請求。
API格式
GET /privateEndpoints
要求
下列請求會擷取貴組織中所有私人端點的清單。
code language-shell |
---|
|
回應
成功的回應會傳回組織中私人端點的清單。
code language-json |
---|
|
擷取指定來源的私人端點清單 retrieve-private-endpoints-by-source
若要擷取與特定來源對應的私人端點清單,請向/privateEndpoints
端點發出GET要求並提供來源的connectionSpec.id
。
API格式
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
要求
下列要求會擷取與具有連線規格ID之來源對應的所有私人端點的清單: 4c10e202-c428-4796-9208-5f1f5732b1cf
。
code language-shell |
---|
|
回應
成功的回應會傳回所有私人端點的清單,這些端點對應到連線規格ID為4c10e202-c428-4796-9208-5f1f5732b1cf
的來源。
code language-json |
---|
|
擷取私人端點 retrieve-specific-private-endpoint
若要擷取特定的私用端點,請向/privateEndpoints
發出GET請求,並提供您要擷取的私用端點識別碼。
API格式
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
要求
下列要求會擷取識別碼為2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
的私用端點。
code language-shell |
---|
|
回應
成功的回應傳回識別碼為2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
的私人端點
code language-json |
---|
|
解析私人端點 resolve-private-endpoint
API格式
GET /privateEndpoints?op=autoResolve
要求
code language-shell |
---|
|
回應
code language-json |
---|
|
啟用Interactive Authoring enable-interactive-authoring
Interactive Authoring用於探索連線或帳戶以及預覽資料等功能。 若要啟用Interactive Authoring,請向/privateEndpoints/interactiveAuthoring
發出POST要求,並在查詢引數中將enable
指定為運運算元。
API格式
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
值設定為enable
。要求
下列要求會啟用您私人端點的Interactive Authoring,並將TTL設為60分鐘。
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
屬性 | 說明 |
autoTerminationMinutes |
Interactive Authoring TTL (存留時間)以分鐘為單位。 Interactive Authoring用於探索連線或帳戶以及預覽資料等功能。 您最多可以設定120分鐘的TTL。 預設TTL為60分鐘。 |
回應
成功的回應會傳回HTTP狀態202 (已接受)。
擷取Interactive Authoring狀態 retrieve-interactive-authoring-status
若要檢視您私人端點的Interactive Authoring目前狀態,請向/privateEndpoints/interactiveAuthoring
發出GET要求。
API格式
GET /privateEndpoints/interactiveAuthoring
要求
下列要求會擷取Interactive Authoring的狀態:
code language-shell |
---|
|
回應
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
屬性 | 說明 |
status |
Interactive Authoring的狀態。 有效值包括: disabled 、enabling 、enabled 。 |
刪除私人端點 delete-private-endpoint
若要刪除您的私人端點,請向/privateEndpoints
發出DELETE請求,並提供您要刪除的端點識別碼。
API格式
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
要求
下列要求會刪除識別碼為02a74b31-a566-4a86-9cea-309b101a7f24
的私人端點。
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態200 (成功)。 您可以發出GET要求並向/privateEndpoints
提供已刪除的ID作為查詢引數,以驗證刪除。
流程服務 flow-service
請閱讀下列章節,以瞭解如何結合Flow Service API使用私人端點。
建立與私人端點的連線 create-base-connection
若要在Experience Platform中建立與私人端點的連線,請對/connections
API的Flow Service端點提出POST要求。
API格式
POST /connections/
要求
下列要求會建立Azure Blob Storage的已驗證基底連線,同時使用私用端點。
code language-shell |
---|
|
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 | |
---|---|
屬性 | 說明 |
name |
基礎連線的名稱。 |
description |
(選用)提供連線其他資訊的說明。 |
auth.specName |
用來將您的來源連線至Experience Platform的驗證。 |
auth.params.connectionString |
Azure Blob Storage連線字串。 如需詳細資訊,請閱讀Azure Blob Storage API驗證指南。 |
auth.params.usePrivateLink |
布林值,判斷您是否使用私人端點。 如果您使用私人端點,請將此值設為true 。 |
connectionSpec.id |
Azure Blob Storage的連線規格ID。 |
connectionSpec.version |
您的Azure Blob Storage連線規格ID的版本。 |
回應
成功的回應會傳回您新產生的基本連線ID和etag。
code language-json |
---|
|
擷取繫結至指定私人端點的連線 retrieve-connections-by-endpoint
若要擷取繫結至特定私用端點的連線,請對/connections
端點提出GET要求,並提供私用端點的識別碼作為查詢引數。
API格式
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
要求
下列要求會擷取繫結至識別碼為02a74b31-a566-4a86-9cea-309b101a7f24
之私人端點的現有連線。
code language-shell |
---|
|
回應
成功的回應會傳回繫結至所查詢私人端點的連線清單。
code language-json |
---|
|
擷取與任何私人端點關聯的連線 retrieve-connections
若要擷取與任何私用端點相關聯的連線,請對/connections
端點提出GET要求,並提供property=auth.params.usePrivateLink==true
作為查詢引數。
API格式
GET /connections?property=auth.params.usePrivateLink==true
要求
以下請求會擷取貴組織中使用私人端點的所有連線。
code language-shell |
---|
|
回應
成功的回應會傳回與私人端點繫結的所有連線。
code language-json |
---|
|
附錄
請閱讀本節,以瞭解在API中使用Azure私人連結的其他資訊。
核准Azure Blob和Azure Data Lake Gen2的私人端點
若要核准Azure Blob和Azure Data Lake Gen2來源的私人端點要求,請登入Azure Portal。 在左側導覽中選取 Data storage,然後前往 Security + networking 標籤並選擇 Networking。 接下來,選取「Private endpoints」以檢視與您帳戶相關聯的私人端點清單及其目前的連線狀態。 若要核准擱置的要求,請選取所要的端點,然後按一下 Approve。