Supporto di collegamenti privati per le origini nell’API
Puoi utilizzare la funzione Collegamento privato per creare endpoint privati per le origini Adobe Experience Platform a cui connetterti. Connetti in modo sicuro le origini a una rete virtuale utilizzando indirizzi IP privati, eliminando la necessità di IP pubblici e riducendo la superficie di attacco. Semplifica la configurazione della rete eliminando la necessità di configurazioni complesse di firewall o Network Address Translation, garantendo al contempo che il traffico dati raggiunga solo i servizi approvati.
Leggi questa guida per scoprire come utilizzare le API per creare e utilizzare un endpoint privato.
Adesione all’utilizzo della licenza per il supporto del collegamento privato
Le metriche di autorizzazione dell’utilizzo della licenza per il supporto del collegamento privato nelle origini sono le seguenti:
- I clienti hanno diritto a un massimo di 2 TB all'anno di trasferimento di dati tramite origini supportate (Azure Blob Storage, ADLS Gen2 e Azure File Storage), in tutte le sandbox e le organizzazioni.
- Ogni organizzazione può avere un massimo di 10 endpoint per tutte le sandbox di produzione.
- Ogni organizzazione può avere un massimo di 1 endpoint per tutte le sandbox di sviluppo.
Introduzione
Questa guida richiede una buona conoscenza dei seguenti componenti di Experience Platform:
- Origini: Experience Platform consente di acquisire dati da varie origini e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experience Platform.
- Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza Experience Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.
Utilizzo delle API di Platform
Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida in guida introduttiva alle API di Platform.
Creare un endpoint privato create-private-endpoint
Per creare un endpoint privato, effettuare una richiesta POST a /privateEndpoints
.
Formato API
POST /privateEndpoints
Richiesta
La richiesta seguente crea un endpoint privato:
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 | |
---|---|
Proprietà | Descrizione |
name |
Nome dell’endpoint privato. |
subscriptionId |
ID associato all'abbonamento Azure. Per ulteriori informazioni, leggere la guida di Azure in recupero degli ID sottoscrizione e tenant da Azure Portal. |
resourceGroupName |
Il nome del gruppo di risorse in Azure. Un gruppo di risorse contiene risorse correlate per una soluzione Azure. Per ulteriori informazioni, leggere la guida di Azure in gestione dei gruppi di risorse. |
resourceName |
Nome della risorsa. In Azure una risorsa fa riferimento a istanze quali macchine virtuali, applicazioni Web e database. Per ulteriori informazioni, leggere la guida di Azure in informazioni sul gestore delle risorse Azure. |
connectionSpec.id |
ID della specifica di connessione dell'origine in uso. |
connectionSpec.version |
Versione dell'ID della specifica di connessione in uso. |
Risposta
In caso di esito positivo, la risposta restituisce quanto segue:
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 | |
---|---|
Proprietà | Descrizione |
id |
ID dell’endpoint privato appena creato. |
name |
Nome dell’endpoint privato. |
subscriptionId |
ID associato all'abbonamento Azure. Per ulteriori informazioni, leggere la guida di Azure in recupero degli ID sottoscrizione e tenant da Azure Portal. |
resourceGroupName |
Il nome del gruppo di risorse in Azure. Un gruppo di risorse contiene risorse correlate per una soluzione Azure. Per ulteriori informazioni, leggere la guida di Azure in gestione dei gruppi di risorse. |
resourceName |
Nome della risorsa. In Azure una risorsa fa riferimento a istanze quali macchine virtuali, applicazioni Web e database. Per ulteriori informazioni, leggere la guida di Azure in informazioni sul gestore delle risorse Azure. |
connectionSpec.id |
ID della specifica di connessione dell'origine in uso. |
connectionSpec.version |
Versione dell'ID della specifica di connessione in uso. |
state |
Lo stato corrente dell’endpoint privato. Gli stati validi includono:
|
Recuperare un elenco di endpoint privati retrieve-private-endpoints
Per recuperare un elenco di endpoint privati da una data sandbox nell'organizzazione, effettuare una richiesta GET a /privateEndpoints
.
Formato API
GET /privateEndpoints
Richiesta
La richiesta seguente recupera un elenco di tutti gli endpoint privati presenti nell’organizzazione.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce un elenco di endpoint privati dell’organizzazione.
code language-json |
---|
|
Recuperare un elenco di endpoint privati per una determinata origine retrieve-private-endpoints-by-source
Per recuperare un elenco di endpoint privati corrispondenti a un'origine specifica, effettuare una richiesta GET all'endpoint /privateEndpoints
e fornire connectionSpec.id
dell'origine.
Formato API
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
Richiesta
La richiesta seguente recupera un elenco di tutti gli endpoint privati corrispondenti all'origine con ID specifica di connessione: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce un elenco di tutti gli endpoint privati corrispondenti all'origine con ID della specifica di connessione: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-json |
---|
|
Recuperare un endpoint privato retrieve-specific-private-endpoint
Per recuperare un endpoint privato specifico, effettuare una richiesta GET a /privateEndpoints
e fornire l'ID dell'endpoint privato che si desidera recuperare.
Formato API
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Richiesta
La richiesta seguente recupera l'endpoint privato con ID:2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce l'endpoint privato con ID 2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
code language-json |
---|
|
Risolvere un endpoint privato resolve-private-endpoint
Formato API
GET /privateEndpoints?op=autoResolve
Richiesta
code language-shell |
---|
|
Risposta
code language-json |
---|
|
Abilita Interactive Authoring enable-interactive-authoring
Interactive Authoring viene utilizzato per funzionalità quali l'esplorazione di una connessione o di un account e la visualizzazione in anteprima dei dati. Per abilitare Interactive Authoring, effettuare una richiesta POST a /privateEndpoints/interactiveAuthoring
e specificare enable
come operatore nei parametri di query.
Formato API
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
su enable
.Richiesta
La richiesta seguente abilita Interactive Authoring per l'endpoint privato e imposta il TTL su 60 minuti.
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Proprietà | Descrizione |
autoTerminationMinutes |
Il valore TTL di Interactive Authoring (time-to-live) in minuti. Interactive Authoring viene utilizzato per funzionalità quali l'esplorazione di una connessione o di un account e la visualizzazione in anteprima dei dati. Puoi impostare un TTL massimo di 120 minuti. Il valore TTL predefinito è 60 minuti. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 (Accettato).
Recupera stato Interactive Authoring retrieve-interactive-authoring-status
Per visualizzare lo stato corrente di Interactive Authoring per l'endpoint privato, effettuare una richiesta GET a /privateEndpoints/interactiveAuthoring
.
Formato API
GET /privateEndpoints/interactiveAuthoring
Richiesta
La richiesta seguente recupera lo stato di Interactive Authoring:
code language-shell |
---|
|
Risposta
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Proprietà | Descrizione |
status |
Stato di Interactive Authoring. I valori validi includono: disabled , enabling , enabled . |
Elimina endpoint privato delete-private-endpoint
Per eliminare l'endpoint privato, effettuare una richiesta DELETE a /privateEndpoints
e fornire l'ID dell'endpoint che si desidera eliminare.
Formato API
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Richiesta
La richiesta seguente elimina l'endpoint privato con ID: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 (Completato). Puoi verificare l'eliminazione effettuando una richiesta GET e a /privateEndpoints
e fornendo l'ID eliminato come parametro di query.
Servizio di flusso flow-service
Leggi le sezioni seguenti per informazioni su come utilizzare endpoint privati insieme all'Flow Service API.
Creare una connessione con un endpoint privato create-base-connection
Per creare una connessione con un endpoint privato in Experience Platform, effettuare una richiesta POST all'endpoint /connections
dell'API Flow Service.
Formato API
POST /connections/
Richiesta
La richiesta seguente crea una connessione di base autenticata per Azure Blob Storage, utilizzando anche un endpoint privato.
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 | |
---|---|
Proprietà | Descrizione |
name |
Nome della connessione di base. |
description |
(Facoltativo) Una descrizione che fornisce informazioni aggiuntive sulla connessione. |
auth.specName |
Autenticazione utilizzata per connettere l’origine ad Experience Platform. |
auth.params.connectionString |
Stringa di connessione Azure Blob Storage. Per ulteriori informazioni, leggere la Azure Blob Storage guida all'autenticazione API. |
auth.params.usePrivateLink |
Valore booleano che determina se si utilizza o meno un endpoint privato. Impostare questo valore su true se si utilizza un endpoint privato. |
connectionSpec.id |
ID della specifica di connessione di Azure Blob Storage. |
connectionSpec.version |
Versione dell'ID della specifica di connessione Azure Blob Storage. |
Risposta
In caso di esito positivo, la risposta restituisce l’ID e l’eTag della connessione di base appena generati.
code language-json |
---|
|
Recuperare le connessioni associate a un determinato endpoint privato retrieve-connections-by-endpoint
Per recuperare le connessioni associate a un particolare endpoint privato, effettuare una richiesta GET all'endpoint /connections
e fornire l'ID dell'endpoint privato come parametro di query.
Formato API
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
Richiesta
La richiesta seguente recupera le connessioni esistenti associate all'endpoint privato con ID: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce un elenco di connessioni associate all’endpoint privato sottoposto a query.
code language-json |
---|
|
Recuperare le connessioni associate a qualsiasi endpoint privato retrieve-connections
Per recuperare le connessioni associate a qualsiasi endpoint privato, effettuare una richiesta GET all'endpoint /connections
e fornire property=auth.params.usePrivateLink==true
come parametro di query.
Formato API
GET /connections?property=auth.params.usePrivateLink==true
Richiesta
La richiesta seguente recupera tutte le connessioni dell’organizzazione che utilizzano endpoint privati.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce tutte le connessioni associate a endpoint privati.
code language-json |
---|
|
Appendice
Leggi questa sezione per ulteriori informazioni utilizzando Azure collegamenti privati nell'API.
Approva un endpoint privato per Azure Blob e Azure Data Lake Gen2
Per approvare una richiesta di endpoint privato per le origini Azure Blob e Azure Data Lake Gen2, accedere a Azure Portal. Nel menu di navigazione a sinistra, selezionare Data storage, quindi passare alla scheda Security + networking e scegliere Networking. Quindi, seleziona Private endpoints per visualizzare un elenco di endpoint privati associati al tuo account e ai relativi stati di connessione correnti. Per approvare una richiesta in sospeso, selezionare l'endpoint desiderato e fare clic su Approve.