Documentação Experience Platform Guia dos conectores de origem

Suporte a link privado para fontes na API

Last update: Wed Sep 24 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Desenvolvedor

AVAILABILITY

Esse recurso é compatível com as seguintes fontes:

No momento, o Suporte a links privados está disponível apenas para organizações que compraram o Adobe Healthcare Shield ou o Adobe Privacy & Security Shield.

Você pode usar o recurso Link privado para criar endpoints privados para as fontes da Adobe Experience Platform às quais se conectar. Conecte com segurança suas fontes a uma rede virtual usando endereços IP privados, eliminando a necessidade de IPs públicos e reduzindo sua superfície de ataque. Simplifique a configuração da rede, eliminando a necessidade de configurações complexas de firewall ou tradução de endereço de rede, garantindo que o tráfego de dados atinja apenas os serviços aprovados.

Leia este guia para saber como você pode usar APIs para criar e usar um terminal privado.

recommendation-more-help

Direito de uso de licença para suporte a link privado

As métricas de direito de uso de licença para suporte a links privados nas origens são as seguintes:

Os clientes têm direito a até 2 TB por ano de transferência de dados por meio de fontes compatíveis (Azure Blob Storage, ADLS Gen2 e Azure File Storage), em todas as sandboxes e organizações.
Cada organização pode ter no máximo 10 endpoints para todas as sandboxes de produção.
Cada organização pode ter no máximo um terminal para todas as sandboxes de desenvolvimento.

style

shade-box

Introdução

Este guia requer uma compreensão funcional dos seguintes componentes do Experience Platform:

Fontes: o Experience Platform permite a assimilação de dados de várias fontes, ao mesmo tempo em que fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Experience Platform.
Sandboxes: a Experience Platform fornece sandboxes virtuais que particionam uma única instância do Experience Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.

Criar um ponto de extremidade privado create-private-endpoint

Para criar um ponto de extremidade privado, faça uma solicitação POST para /privateEndpoints.

Formato da API

POST /privateEndpoints

Solicitação

A solicitação a seguir cria um ponto de extremidade privado:

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
curl -X POST \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/' \ -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": "ACME Private Endpoint", "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3", "resourceGroupName": "acme-sources-experience-platform", "resourceName": "acmeexperienceplatform", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } }'

curl -X POST \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/' \
  -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": "ACME Private Endpoint",
      "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3",
      "resourceGroupName": "acme-sources-experience-platform",
      "resourceName": "acmeexperienceplatform",
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "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
Propriedade	Descrição
`name`	O nome do seu ponto de extremidade privado.
`subscriptionId`	A ID associada à sua assinatura do Azure. Para obter mais informações, leia o guia Azure em recuperando sua assinatura e IDs de locatário de Azure Portal.
`resourceGroupName`	O nome do seu grupo de recursos em Azure. Um grupo de recursos contém recursos relacionados para uma solução Azure. Para obter mais informações, leia o guia Azure em gerenciando grupos de recursos.
`resourceName`	O nome do recurso. Em Azure, um recurso se refere a instâncias como máquinas virtuais, aplicativos Web e bancos de dados. Para obter mais informações, leia o guia Azure em noções básicas sobre o Azure gerenciador de recursos.
`connectionSpec.id`	A ID de especificação da conexão da origem que você está usando.
`connectionSpec.version`	A versão da ID de especificação de conexão que você está usando.

Resposta

Uma resposta bem-sucedida retorna o seguinte:

Selecione para exibir o exemplo de resposta

code language-json

code language-json
`{ "id": "2c7f6574-299a-4832-aec5-886e875872e2", "name": "ACME Private Endpoint", "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3", "resourceGroupName": "acme-sources-experience-platform", "resourceName": "acmeexperienceplatform", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" }, "state": "Pending" }`

{
  "id": "2c7f6574-299a-4832-aec5-886e875872e2",
  "name": "ACME Private Endpoint",
  "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3",
  "resourceGroupName": "acme-sources-experience-platform",
  "resourceName": "acmeexperienceplatform",
  "connectionSpec": {
      "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
      "version": "1.0"
  },
  "state": "Pending"
}

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
Propriedade	Descrição
`id`	A ID do terminal privado recém-criado.
`name`	O nome do seu ponto de extremidade privado.
`subscriptionId`	A ID associada à sua assinatura do Azure. Para obter mais informações, leia o guia Azure em recuperando sua assinatura e IDs de locatário de Azure Portal.
`resourceGroupName`	O nome do seu grupo de recursos em Azure. Um grupo de recursos contém recursos relacionados para uma solução Azure. Para obter mais informações, leia o guia Azure em gerenciando grupos de recursos.
`resourceName`	O nome do recurso. Em Azure, um recurso se refere a instâncias como máquinas virtuais, aplicativos Web e bancos de dados. Para obter mais informações, leia o guia Azure em noções básicas sobre o Azure gerenciador de recursos.
`connectionSpec.id`	A ID de especificação da conexão da origem que você está usando.
`connectionSpec.version`	A versão da ID de especificação de conexão que você está usando.
`state`	O estado atual do seu ponto de extremidade privado. Os estados válidos incluem: `Pending` `Failed` `Approved` `Rejected`

Recuperar uma lista de pontos de extremidade privados retrieve-private-endpoints

Para recuperar uma lista de pontos de extremidade privados de uma determinada sandbox em sua organização, faça uma solicitação GET para /privateEndpoints.

Formato da API

GET /privateEndpoints

Solicitação

A solicitação a seguir recupera uma lista de todos os endpoints privados existentes em sua organização.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna uma lista de pontos de extremidade privados na organização.

Selecione para exibir o exemplo de resposta

code language-json

code language-json
{ "items": [ { "id": "ac9eb695-0d1a-42d4-bc45-0842aeaa1eff", "name": "TEST_E2E_29_Jan", "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3", "resourceGroupName": "acme-noid-experience-platform", "resourceName": "acmeprivatelinking", "fqdns": [ ], "state": "Approved", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } }, { "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr", "name": "TEST_E2E_29_Jan", "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0", "resourceGroupName": "acme-sources-experience-platform", "resourceName": "acmeexperienceplatform", "fqdns": [ ], "state": "Pending", "connectionSpec": { "id": "b3ba5556-48be-44b7-8b85-ff2b69b46dc4", "version": "1.0" } } ] }

{
  "items": [
       {
      "id": "ac9eb695-0d1a-42d4-bc45-0842aeaa1eff",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3",
      "resourceGroupName": "acme-noid-experience-platform",
      "resourceName": "acmeprivatelinking",
      "fqdns": [

      ],
      "state": "Approved",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      }
    },
          {
      "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0",
      "resourceGroupName": "acme-sources-experience-platform",
      "resourceName": "acmeexperienceplatform",
      "fqdns": [

      ],
      "state": "Pending",
      "connectionSpec": {
        "id": "b3ba5556-48be-44b7-8b85-ff2b69b46dc4",
        "version": "1.0"
      }
    }
  ]
}

Recuperar uma lista de pontos de extremidade privados para uma determinada fonte retrieve-private-endpoints-by-source

Para recuperar uma lista de pontos de extremidade privados que correspondam a uma origem específica, faça uma solicitação GET para o ponto de extremidade /privateEndpoints e forneça o connectionSpec.id da origem.

Formato da API

GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}

Parâmetros de consulta

Descrição

{CONNECTION_SPEC_ID}

A ID de especificação de conexão da origem para a qual você deseja pesquisar pontos de extremidade privados.

Solicitação

A solicitação a seguir recupera uma lista de todos os pontos de extremidade privados que correspondem à origem com ID de especificação de conexão: 4c10e202-c428-4796-9208-5f1f5732b1cf.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints?property=connectionSpec.id==4c10e202-c428-4796-9208-5f1f5732b1cf' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints?property=connectionSpec.id==4c10e202-c428-4796-9208-5f1f5732b1cf' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna uma lista de todos os pontos de extremidade privados que correspondem à origem com a ID de especificação de conexão: 4c10e202-c428-4796-9208-5f1f5732b1cf.

Selecione para exibir o exemplo de resposta

code language-json

code language-json
{ "items": [ { "id": "ac9eb695-0d1a-42d4-bc45-0842aeaa1eff", "name": "TEST_E2E_29_Jan", "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3", "resourceGroupName": "acme-noid-experience-platform", "resourceName": "acmeprivatelinkhg", "fqdns": [ ], "state": "Approved", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } }, { "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr", "name": "TEST_E2E_29_Jan", "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0", "resourceGroupName": "acme-sources-experience-platform", "resourceName": "acmeexperienceplatform", "fqdns": [ ], "state": "Pending", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } } ] }

{
  "items": [
       {
      "id": "ac9eb695-0d1a-42d4-bc45-0842aeaa1eff",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "4281a16a-696f-4993-a7d3-a3da32b846f3",
      "resourceGroupName": "acme-noid-experience-platform",
      "resourceName": "acmeprivatelinkhg",
      "fqdns": [

      ],
      "state": "Approved",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      }
    },
    {
      "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0",
      "resourceGroupName": "acme-sources-experience-platform",
      "resourceName": "acmeexperienceplatform",
      "fqdns": [

      ],
      "state": "Pending",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      }
    }
  ]
}

Recuperar um ponto de extremidade privado retrieve-specific-private-endpoint

Para recuperar um ponto de extremidade privado específico, faça uma solicitação GET para /privateEndpoints e forneça a ID do ponto de extremidade privado que você deseja recuperar.

Formato da API

GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}

Parâmetros de consulta

Descrição

{PRIVATE_ENDPOINT_ID}

A ID do ponto de extremidade privado que você deseja recuperar.

Solicitação

A solicitação a seguir recupera o ponto de extremidade privado com a ID:2c5699b0-b9b6-486f-8877-ee5e21fe9a9d.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/2c5699b0-b9b6-486f-8877-ee5e21fe9a9d' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/2c5699b0-b9b6-486f-8877-ee5e21fe9a9d' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna o ponto de extremidade privado com ID: 2c5699b0-b9b6-486f-8877-ee5e21fe9a9d

Selecione para exibir o exemplo de resposta

code language-json

code language-json
`{ "items": [ { "id": "2c5699b0-b9b6-486f-8877-ee5e21fe9a9d", "name": "TEST_E2E_29_Jan", "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0", "resourceGroupName": "acme-noid-experience-platform", "resourceName": "acmeprivatelinkhg", "fqdns": [ ], "state": "Approved", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } } ] }`

{
  "items": [
       {
      "id": "2c5699b0-b9b6-486f-8877-ee5e21fe9a9d",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0",
      "resourceGroupName": "acme-noid-experience-platform",
      "resourceName": "acmeprivatelinkhg",
      "fqdns": [

      ],
      "state": "Approved",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      }
    }
  ]
}

Resolver um ponto de extremidade privado resolve-private-endpoint

Formato da API

GET /privateEndpoints?op=autoResolve

Solicitação

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
curl -X GET \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints?op=autoResolve' \ -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 '{ "auth": { "specName": "ConnectionString", "params": { "usePrivateLink": true, "connectionString": "{CONNECTION_STRING}" } }, "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } }'

curl -X GET \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints?op=autoResolve' \
  -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 '{
      "auth": {
          "specName": "ConnectionString",
          "params": {
              "usePrivateLink": true,
              "connectionString": "{CONNECTION_STRING}"
          }
      },
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "version": "1.0"
      }
  }'

Resposta

Selecione para exibir o exemplo de resposta

code language-json

code language-json
`{ "items": [ { "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr", "name": "TEST_E2E_29_Jan", "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0", "resourceGroupName": "acme-sources-experience-platform", "resourceName": "acmeexperienceplatform", "fqdns": [ ], "state": "Pending", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } } ] }`

{
  "items": [
        {
      "id": "4c9eb695-0d1a-42d4-bc45-0842aeaa1efr",
      "name": "TEST_E2E_29_Jan",
      "subscriptionId": "5a0ff2f3-53d6-47e4-abb5-10a18bd3fff0",
      "resourceGroupName": "acme-sources-experience-platform",
      "resourceName": "acmeexperienceplatform",
      "fqdns": [

      ],
      "state": "Pending",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      }
    }
  ]
}

Habilitar Interactive Authoring enable-interactive-authoring

IMPORTANT

Você deve habilitar Interactive Authoring antes de criar ou atualizar um fluxo e antes de criar, atualizar ou explorar uma conexão.

Interactive Authoring é usado para funcionalidades como explorar uma conexão ou conta e visualizar dados. Para habilitar Interactive Authoring, faça uma solicitação POST para /privateEndpoints/interactiveAuthoring e especifique enable como operador em seus parâmetros de consulta.

Formato da API

POST /privateEndpoints/interactiveAuthoring?op=enable

Parâmetros de consulta

Descrição

op

A operação que você deseja executar. Para habilitar Interactive Authoring, defina o valor op como enable.

Solicitação

A solicitação a seguir habilita Interactive Authoring para seu ponto de extremidade privado e define o TTL como 60 minutos.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X POST \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/interactiveAuthoring?op=enable' \ -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 '{ "autoTerminationMinutes": 60 }'`

curl -X POST \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/interactiveAuthoring?op=enable' \
  -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 '{
      "autoTerminationMinutes": 60
  }'

table 0-row-2 1-row-2
Propriedade	Descrição
`autoTerminationMinutes`	O TTL (tempo de vida útil) Interactive Authoring em minutos. Interactive Authoring é usado para funcionalidades como explorar uma conexão ou conta e visualizar dados. Você pode definir um TTL máximo de 120 minutos. O TTL padrão é de 60 minutos.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 202 (Accepted).

Recuperar status de Interactive Authoring retrieve-interactive-authoring-status

Para exibir o status atual de Interactive Authoring para seu ponto de extremidade privado, faça uma solicitação GET para /privateEndpoints/interactiveAuthoring.

Formato da API

GET /privateEndpoints/interactiveAuthoring

Solicitação

A solicitação a seguir recupera o status de Interactive Authoring:

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/interactiveAuthoring' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/interactiveAuthoring' \
  -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' \

Resposta

Selecione para exibir o exemplo de resposta

code language-json
`{ "status": "Disabled" }`

table 0-row-2 1-row-2
Propriedade	Descrição
`status`	O status de Interactive Authoring. Os valores válidos incluem: `disabled`, `enabling`, `enabled`.

Excluir ponto de acesso privado delete-private-endpoint

Para excluir seu ponto de extremidade privado, faça uma solicitação DELETE para /privateEndpoints e forneça a ID do ponto de extremidade que deseja excluir.

Formato da API

DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}

Parâmetros de consulta

Descrição

{PRIVATE_ENDPOINT_ID}

A ID da empresa privada que você deseja excluir.

Solicitação

A solicitação a seguir exclui o ponto de extremidade privado com ID: 02a74b31-a566-4a86-9cea-309b101a7f24.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X DELETE \ 'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/02a74b31-a566-4a86-9cea-309b101a7f24' \ -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' \`

curl -X DELETE \
  'https://platform.adobe.io/data/foundation/connectors/privateEndpoints/02a74b31-a566-4a86-9cea-309b101a7f24' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 (Sucesso). Você pode verificar a exclusão fazendo uma solicitação GET e para /privateEndpoints e fornecendo a ID excluída como um parâmetro de consulta.

Serviço de fluxo flow-service

Leia as seções a seguir para obter informações sobre como usar pontos de extremidade privados em conjunto com a Flow Service API.

Criar uma conexão com um ponto de extremidade privado create-base-connection

Para criar uma conexão com um ponto de extremidade privado no Experience Platform, faça uma solicitação POST para o ponto de extremidade /connections da API Flow Service.

Formato da API

POST /connections/

Solicitação

A solicitação a seguir cria uma conexão de base autenticada para Azure Blob Storage, ao mesmo tempo em que usa um ponto de extremidade privado.

Selecione para exibir o exemplo de solicitação

code language-shell

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": "Azure Blob Storage base connection", "description": "A base connection for a Azure Blob Storage source that uses a private link.", "auth": { "specName": "ConnectionString", "params": { "connectionString": "{CONNECTION_STRING}", "usePrivateLink" : true } }, "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" } }'

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": "Azure Blob Storage base connection",
      "description": "A base connection for a Azure Blob Storage source that uses a private link.",
      "auth": {
          "specName": "ConnectionString",
          "params": {
              "connectionString": "{CONNECTION_STRING}",
              "usePrivateLink" : true
          }
      },
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "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
Propriedade	Descrição
`name`	O nome da sua conexão básica.
`description`	(Opcional) Uma descrição que fornece informações adicionais sobre sua conexão.
`auth.specName`	A autenticação que está sendo usada para conectar sua origem ao Experience Platform.
`auth.params.connectionString`	A cadeia de conexão Azure Blob Storage. Para obter mais informações, leia o Azure Blob Storage guia de autenticação de API.
`auth.params.usePrivateLink`	Um valor booleano que determina se você está usando ou não um ponto de extremidade privado. Defina esse valor como `true` se estiver usando um ponto de extremidade privado.
`connectionSpec.id`	A ID de especificação de conexão de Azure Blob Storage.
`connectionSpec.version`	A versão da ID de especificação da conexão do Azure Blob Storage.

Resposta

Uma resposta bem-sucedida retorna a ID de conexão básica recém-gerada e a tag.

Selecione para exibir o exemplo de resposta

code language-json
`{ "id": "a59d368a-1152-4673-a46e-bd52e8cdb9a9", "etag": "\"f50185ed-0000-0200-0000-637e8fad0000\"" }`

Recuperar conexões vinculadas a um determinado ponto de extremidade privado retrieve-connections-by-endpoint

Para recuperar conexões vinculadas a um ponto de extremidade privado específico, faça uma solicitação GET para o ponto de extremidade /connections e forneça a ID do ponto de extremidade privado como um parâmetro de consulta.

Formato da API

GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}

Parâmetros de consulta

Descrição

A ID do ponto de extremidade privado vinculado às conexões que você deseja recuperar.

Solicitação

A solicitação a seguir recupera conexões existentes vinculadas ao ponto de extremidade privado com ID: 02a74b31-a566-4a86-9cea-309b101a7f24.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/flowservice/connections?property=auth.params.privateEndpointId==02a74b31-a566-4a86-9cea-309b101a7f24' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections?property=auth.params.privateEndpointId==02a74b31-a566-4a86-9cea-309b101a7f24' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna uma lista de conexões vinculadas ao ponto de extremidade privado consultado.

Selecione para exibir o exemplo de resposta

code language-json

code language-json
{ "items": [ { "id": "42a27b1f-8e3f-48ce-8c29-7e474b29a015", "createdAt": 1729154379292, "updatedAt": 1729154382031, "createdBy": "{CREATED_BY}", "updatedBy": "{UPDATED_BY}", "createdClient": "{CREATED_CLIENT}", "updatedClient": "{UPDATED_CLIENT}", "sandboxId": "{SANDBOX_ID}", "sandboxName": "{SANDBOX_NAME}", "imsOrgId": "{ORG_NAME}", "name": "acme-e2e", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" }, "state": "enabled", "auth": { "specName": "ConnectionString", "params": { "connectionString": "{CONNECTION_STRING}", "usePrivateLink": true, "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24" } }, "version": "\"2f01454b-0000-0200-0000-6766749a0000\"", "etag": "\"2f01454b-0000-0200-0000-6766749a0000\"", "lastOperation": { "started": 0, "updated": 0, "operation": "create" } }, { "id": "6350311a-664c-4b08-aad4-4065781aac81", "createdAt": 1718199941102, "updatedAt": 1718199945147, "createdBy": "{CREATED_BY}", "updatedBy": "{UPDATED_BY}", "createdClient": "{CREATED_CLIENT}", "updatedClient": "{UPDATED_CLIENT}", "sandboxId": "{SANDBOX_ID}", "sandboxName": "{SANDBOX_NAME}", "imsOrgId": "{ORG_NAME}", "name": "acme demo", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" }, "state": "enabled", "auth": { "specName": "ConnectionString", "params": { "connectionString": "{CONNECTION_STRING}", "usePrivateLink": true, "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24" } }, "version": "\"3001307e-0000-0200-0000-6766cf710000\"", "etag": "\"3001307e-0000-0200-0000-6766cf710000\"", "lastOperation": { "started": 0, "updated": 0, "operation": "create" } } ], "_links": { } }

{
  "items": [
    {
      "id": "42a27b1f-8e3f-48ce-8c29-7e474b29a015",
      "createdAt": 1729154379292,
      "updatedAt": 1729154382031,
      "createdBy": "{CREATED_BY}",
      "updatedBy": "{UPDATED_BY}",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_NAME}",
      "name": "acme-e2e",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      },
      "state": "enabled",
      "auth": {
        "specName": "ConnectionString",
        "params": {
          "connectionString": "{CONNECTION_STRING}",
          "usePrivateLink": true,
          "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24"
        }
      },
      "version": "\"2f01454b-0000-0200-0000-6766749a0000\"",
      "etag": "\"2f01454b-0000-0200-0000-6766749a0000\"",
      "lastOperation": {
        "started": 0,
        "updated": 0,
        "operation": "create"
      }
    },
    {
      "id": "6350311a-664c-4b08-aad4-4065781aac81",
      "createdAt": 1718199941102,
      "updatedAt": 1718199945147,
      "createdBy": "{CREATED_BY}",
      "updatedBy": "{UPDATED_BY}",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_NAME}",
      "name": "acme demo",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      },
      "state": "enabled",
      "auth": {
        "specName": "ConnectionString",
        "params": {
          "connectionString": "{CONNECTION_STRING}",
          "usePrivateLink": true,
          "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24"
        }
      },
      "version": "\"3001307e-0000-0200-0000-6766cf710000\"",
      "etag": "\"3001307e-0000-0200-0000-6766cf710000\"",
      "lastOperation": {
        "started": 0,
        "updated": 0,
        "operation": "create"
      }
    }
  ],
  "_links": {

  }
}

Recuperar conexões associadas a qualquer ponto de extremidade privado retrieve-connections

Para recuperar conexões associadas a qualquer ponto de extremidade privado, faça uma solicitação GET para o ponto de extremidade /connections e forneça property=auth.params.usePrivateLink==true como um parâmetro de consulta.

Formato da API

GET /connections?property=auth.params.usePrivateLink==true

Solicitação

A solicitação a seguir recupera todas as conexões em sua organização que estão usando pontos de extremidade privados.

Selecione para exibir o exemplo de solicitação

code language-shell

code language-shell
`curl -X GET \ 'https://platform.adobe.io/data/foundation/flowservice/connections?property=auth.params.usePrivateLink==true' \ -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' \`

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections?property=auth.params.usePrivateLink==true' \
  -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' \

Resposta

Uma resposta bem-sucedida retorna todas as conexões vinculadas a pontos de extremidade privados.

Selecione para exibir o exemplo de resposta

code language-json

code language-json
{ "items": [ { "id": "42a27b1f-8e3f-48ce-8c29-7e474b29a015", "createdAt": 1729154379292, "updatedAt": 1729154382031, "createdBy": "{CREATED_BY}", "updatedBy": "{UPDATED_BY}", "createdClient": "{CREATED_CLIENT}", "updatedClient": "{UPDATED_CLIENT}", "sandboxId": "{SANDBOX_ID}", "sandboxName": "{SANDBOX_NAME}", "imsOrgId": "{ORG_NAME}", "name": "acme-e2e", "connectionSpec": { "id": "4c10e202-c428-4796-9208-5f1f5732b1cf", "version": "1.0" }, "state": "enabled", "auth": { "specName": "ConnectionString", "params": { "connectionString": "{CONNECTION_STRING}", "usePrivateLink": true, "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24" } }, "version": "\"2f01454b-0000-0200-0000-6766749a0000\"", "etag": "\"2f01454b-0000-0200-0000-6766749a0000\"", "lastOperation": { "started": 0, "updated": 0, "operation": "create" } }, { "id": "6350311a-664c-4b08-aad4-4065781aac81", "createdAt": 1718199941102, "updatedAt": 1718199945147, "createdBy": "{CREATED_BY}", "updatedBy": "{UPDATED_BY}", "createdClient": "{CREATED_CLIENT}", "updatedClient": "{UPDATED_CLIENT}", "sandboxId": "{SANDBOX_ID}", "sandboxName": "{SANDBOX_NAME}", "imsOrgId": "{ORG_NAME}", "name": "acme demo", "connectionSpec": { "id": "b2e08744-4f1a-40ce-af30-7abac3e23cf3", "version": "1.0" }, "state": "enabled", "auth": { "specName": "ConnectionString", "params": { "connectionString": "{CONNECTION_STRING}", "usePrivateLink": true } }, "version": "\"3001307e-0000-0200-0000-6766cf710000\"", "etag": "\"3001307e-0000-0200-0000-6766cf710000\"", "lastOperation": { "started": 0, "updated": 0, "operation": "create" } } ], "_links": { } }

{
  "items": [
    {
      "id": "42a27b1f-8e3f-48ce-8c29-7e474b29a015",
      "createdAt": 1729154379292,
      "updatedAt": 1729154382031,
      "createdBy": "{CREATED_BY}",
      "updatedBy": "{UPDATED_BY}",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_NAME}",
      "name": "acme-e2e",
      "connectionSpec": {
        "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
        "version": "1.0"
      },
      "state": "enabled",
      "auth": {
        "specName": "ConnectionString",
        "params": {
          "connectionString": "{CONNECTION_STRING}",
          "usePrivateLink": true,
          "privateEndpointId": "02a74b31-a566-4a86-9cea-309b101a7f24"
        }
      },
      "version": "\"2f01454b-0000-0200-0000-6766749a0000\"",
      "etag": "\"2f01454b-0000-0200-0000-6766749a0000\"",
      "lastOperation": {
        "started": 0,
        "updated": 0,
        "operation": "create"
      }
    },
    {
      "id": "6350311a-664c-4b08-aad4-4065781aac81",
      "createdAt": 1718199941102,
      "updatedAt": 1718199945147,
      "createdBy": "{CREATED_BY}",
      "updatedBy": "{UPDATED_BY}",
      "createdClient": "{CREATED_CLIENT}",
      "updatedClient": "{UPDATED_CLIENT}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "{SANDBOX_NAME}",
      "imsOrgId": "{ORG_NAME}",
      "name": "acme demo",
      "connectionSpec": {
        "id": "b2e08744-4f1a-40ce-af30-7abac3e23cf3",
        "version": "1.0"
      },
      "state": "enabled",
      "auth": {
        "specName": "ConnectionString",
        "params": {
          "connectionString": "{CONNECTION_STRING}",
          "usePrivateLink": true
        }
      },
      "version": "\"3001307e-0000-0200-0000-6766cf710000\"",
      "etag": "\"3001307e-0000-0200-0000-6766cf710000\"",
      "lastOperation": {
        "started": 0,
        "updated": 0,
        "operation": "create"
      }
    }
  ],
  "_links": {

  }
}

Apêndice

Leia esta seção para obter informações adicionais usando os links privados do Azure na API.

Aprovar um ponto de extremidade privado para Azure Blob e Azure Data Lake Gen2

Para aprovar uma solicitação de ponto de extremidade privado para as fontes Azure Blob e Azure Data Lake Gen2, faça logon no Azure Portal. Na navegação à esquerda, selecione Data storage, vá para a guia Security + networking e escolha Networking. Em seguida, selecione Private endpoints para ver uma lista de pontos de extremidade privados associados à sua conta e seus estados de conexão atuais. Para aprovar uma solicitação pendente, selecione o ponto de extremidade desejado e clique em Approve.

O portal do Azure com uma lista de pontos de extremidade privados pendentes.

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