Stöd för privata länkar för källor i API
Du kan använda funktionen Privat länk för att skapa privata slutpunkter som dina Adobe Experience Platform-källor kan ansluta till. Anslut dina källor till ett virtuellt nätverk med privata IP-adresser på ett säkert sätt, så att du slipper använda offentliga IP-adresser och minskar antalet attacker. Förenkla nätverkskonfigurationen genom att eliminera behovet av komplexa brandväggs- eller nätverksadressöversättningskonfigurationer, samtidigt som datatrafiken endast når ut till godkända tjänster.
Läs den här guiden och lär dig hur du kan använda API:er för att skapa och använda en privat slutpunkt.
Licensanvändningsberättigande för stöd för privata länkar
Giltighetsmåtten för licensanvändning för stöd för privata länkar i källor är följande:
- Kunderna har rätt till upp till 2 TB per år dataöverföring via de källor som stöds (Azure Blob Storage, ADLS Gen2 och Azure File Storage), i alla sandlådor och organisationer.
- Varje organisation kan ha högst 10 slutpunkter för alla produktionssandlådor.
- Varje organisation kan ha högst en slutpunkt för alla utvecklingssandlådor.
Kom igång
Handboken kräver en fungerande förståelse av följande komponenter i Experience Platform:
- Källor: Med Experience Platform kan data hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med hjälp av Experience Platform tjänster.
- Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda Experience Platform-instans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.
Använda plattforms-API:er
Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.
Skapa en privat slutpunkt create-private-endpoint
Skapa en POST-begäran till /privateEndpoints
om du vill skapa en privat slutpunkt.
API-format
POST /privateEndpoints
Begäran
I följande begäran skapas en privat slutpunkt:
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 | |
---|---|
Egenskap | Beskrivning |
name |
Namnet på din privata slutpunkt. |
subscriptionId |
Det ID som är kopplat till din Azure-prenumeration. Mer information finns i guiden Azure om hur du hämtar dina prenumerations- och klient-ID:n från Azure Portal. |
resourceGroupName |
Namnet på resursgruppen på Azure. En resursgrupp innehåller relaterade resurser för en Azure-lösning. Mer information finns i guiden Azure om hantering av resursgrupper. |
resourceName |
Namnet på resursen. I Azure refererar en resurs till instanser som virtuella datorer, webbprogram och databaser. Mer information finns i guiden Azure om att förstå Azure resurshanteraren. |
connectionSpec.id |
Anslutningens spec-ID för källan som du använder. |
connectionSpec.version |
Versionen av det anslutningsspec-ID som du använder. |
Svar
Ett lyckat svar returnerar följande:
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 | |
---|---|
Egenskap | Beskrivning |
id |
ID:t för den nyligen skapade privata slutpunkten. |
name |
Namnet på din privata slutpunkt. |
subscriptionId |
Det ID som är kopplat till din Azure-prenumeration. Mer information finns i guiden Azure om hur du hämtar dina prenumerations- och klient-ID:n från Azure Portal. |
resourceGroupName |
Namnet på resursgruppen på Azure. En resursgrupp innehåller relaterade resurser för en Azure-lösning. Mer information finns i guiden Azure om hantering av resursgrupper. |
resourceName |
Namnet på resursen. I Azure refererar en resurs till instanser som virtuella datorer, webbprogram och databaser. Mer information finns i guiden Azure om att förstå Azure resurshanteraren. |
connectionSpec.id |
Anslutningens spec-ID för källan som du använder. |
connectionSpec.version |
Versionen av det anslutningsspec-ID som du använder. |
state |
Det aktuella läget för din privata slutpunkt. Giltiga lägen är:
|
Hämta en lista med privata slutpunkter retrieve-private-endpoints
Om du vill hämta en lista med privata slutpunkter från en viss sandlåda i din organisation, ska du göra en GET-begäran till /privateEndpoints
.
API-format
GET /privateEndpoints
Begäran
Följande begäran hämtar en lista över alla privata slutpunkter som finns i organisationen.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar en lista med privata slutpunkter i organisationen.
code language-json |
---|
|
Hämta en lista med privata slutpunkter för en angiven källa retrieve-private-endpoints-by-source
Om du vill hämta en lista med privata slutpunkter som motsvarar en viss källa, gör du en GET-begäran till /privateEndpoints
-slutpunkten och anger connectionSpec.id
för källan.
API-format
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
Begäran
Följande begäran hämtar en lista över alla privata slutpunkter som motsvarar källan med anslutningsspecifikation-ID: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar en lista med alla privata slutpunkter som motsvarar källan med anslutningsspecifikation-ID: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-json |
---|
|
Hämta en privat slutpunkt retrieve-specific-private-endpoint
Om du vill hämta en specifik privat slutpunkt gör du en GET-begäran till /privateEndpoints
och anger ID:t för den privata slutpunkt som du vill hämta.
API-format
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Begäran
Följande begäran hämtar den privata slutpunkten med ID:2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
.
code language-shell |
---|
|
Svar
Ett svar returnerar den privata slutpunkten med ID: 2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
code language-json |
---|
|
Lösa en privat slutpunkt resolve-private-endpoint
API-format
GET /privateEndpoints?op=autoResolve
Begäran
code language-shell |
---|
|
Svar
code language-json |
---|
|
Aktivera Interactive Authoring enable-interactive-authoring
Interactive Authoring används för funktioner som att utforska en anslutning eller ett konto och förhandsgranska data. Aktivera Interactive Authoring genom att göra en POST-begäran till /privateEndpoints/interactiveAuthoring
och ange enable
som en operator i frågeparametrarna.
API-format
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
till enable
.Begäran
Följande begäran aktiverar Interactive Authoring för din privata slutpunkt och ställer in TTL på 60 minuter.
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Egenskap | Beskrivning |
autoTerminationMinutes |
Interactive Authoring TTL (time-to-live) på några minuter. Interactive Authoring används för funktioner som att utforska en anslutning eller ett konto och förhandsgranska data. Du kan ange en maximal TTL på 120 minuter. Standardvärdet för TTL är 60 minuter. |
Svar
Ett lyckat svar returnerar HTTP-status 202 (Accepterad).
Hämta Interactive Authoring-status retrieve-interactive-authoring-status
Om du vill visa aktuell status för Interactive Authoring för din privata slutpunkt gör du en GET-begäran till /privateEndpoints/interactiveAuthoring
.
API-format
GET /privateEndpoints/interactiveAuthoring
Begäran
Följande begäran hämtar statusen för Interactive Authoring:
code language-shell |
---|
|
Svar
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Egenskap | Beskrivning |
status |
Status för Interactive Authoring. Giltiga värden är: disabled , enabling , enabled . |
Ta bort privat slutpunkt delete-private-endpoint
Om du vill ta bort din privata slutpunkt gör du en DELETE-förfrågan till /privateEndpoints
och anger ID:t för den slutpunkt som du vill ta bort.
API-format
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Begäran
Följande begäran tar bort privat slutpunkt med ID: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 (Slutfört). Du kan verifiera borttagningen genom att göra en GET-begäran och till /privateEndpoints
och ange det borttagna ID:t som en frågeparameter.
Flödestjänst flow-service
I följande avsnitt finns information om hur du kan använda privata slutpunkter tillsammans med Flow Service API.
Skapa en anslutning med en privat slutpunkt create-base-connection
Om du vill skapa en anslutning med en privat slutpunkt i Experience Platform skapar du en POST-begäran till /connections
-slutpunkten i Flow Service API:t.
API-format
POST /connections/
Begäran
Följande begäran skapar en autentiserad basanslutning för Azure Blob Storage, samtidigt som en privat slutpunkt används.
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 | |
---|---|
Egenskap | Beskrivning |
name |
Namnet på din basanslutning. |
description |
(Valfritt) En beskrivning med ytterligare information om anslutningen. |
auth.specName |
Autentiseringen som används för att ansluta källan till Experience Platform. |
auth.params.connectionString |
Anslutningssträngen Azure Blob Storage. Mer information finns i Azure Blob Storage API-autentiseringsguiden. |
auth.params.usePrivateLink |
Ett booleskt värde som avgör om du använder en privat slutpunkt eller inte. Ange det här värdet till true om du använder en privat slutpunkt. |
connectionSpec.id |
Anslutningens spec-ID för Azure Blob Storage. |
connectionSpec.version |
Versionen av ditt Azure Blob Storage-anslutningsspec-ID. |
Svar
Ett lyckat svar returnerar ditt nyligen genererade basanslutnings-ID och -tagg.
code language-json |
---|
|
Hämta anslutningar som är kopplade till en angiven privat slutpunkt retrieve-connections-by-endpoint
Om du vill hämta anslutningar som är kopplade till en viss privat slutpunkt gör du en GET-begäran till slutpunkten /connections
och anger ID:t för den privata slutpunkten som en frågeparameter.
API-format
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
Begäran
Följande begäran hämtar befintliga anslutningar som är kopplade till en privat slutpunkt med ID: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar en lista över anslutningar som är kopplade till den efterfrågade privata slutpunkten.
code language-json |
---|
|
Hämta anslutningar som är associerade med privata slutpunkter retrieve-connections
Om du vill hämta anslutningar som är associerade med en privat slutpunkt, gör du en GET-begäran till slutpunkten /connections
och anger property=auth.params.usePrivateLink==true
som en frågeparameter.
API-format
GET /connections?property=auth.params.usePrivateLink==true
Begäran
Följande begäran hämtar alla anslutningar i organisationen som använder privata slutpunkter.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar alla anslutningar som är kopplade till privata slutpunkter.
code language-json |
---|
|
Bilaga
Läs det här avsnittet om du vill ha mer information om hur du använder Azure privata länkar i API:t.
Godkänn en privat slutpunkt för Azure Blob och Azure Data Lake Gen2
Logga in på Azure Blob om du vill godkänna en privat slutpunktsbegäran för källorna Azure Data Lake Gen2 och Azure Portal. Välj Data storage i den vänstra navigeringen, gå till fliken Security + networking och välj Networking. Välj sedan Private endpoints för att visa en lista över privata slutpunkter som är associerade med ditt konto och deras aktuella anslutningstillstånd. Om du vill godkänna en väntande begäran markerar du önskad slutpunkt och klickar på Approve.