DocumentaçãoExperience PlatformGuia do Serviço de consulta

Ponto de extremidade de acesso IP

Last update: Thu Dec 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
AVAILABILITY
Essa funcionalidade está disponível para clientes que compraram o complemento Data Distiller. Para obter mais informações, entre em contato com o(a) representante da Adobe.

Para proteger o acesso a dados em uma sandbox do Serviço de consulta especificada, use o ponto de extremidade de Acesso a IP para gerenciar intervalos de IP permitidos. Você pode usar essa API para buscar, configurar ou excluir intervalos de IPs associados à ID da sua organização.

Você pode executar as seguintes ações com a API de acesso IP:

  • Buscar todos os intervalos IP
  • Definir novos intervalos IP
  • Excluir intervalos IP existentes

Este documento aborda as solicitações e respostas que você pode fazer e receber do ponto de extremidade /security/ip-access.

NOTE
Você deve ter um token de usuário para chamar essa API. Consulte o guia de introdução para obter informações sobre como adquirir os valores necessários para cada um dos cabeçalhos.

Buscar todos os intervalos IP fetch-all-ip-ranges

Recupere uma lista de todos os intervalos IP configurados para sua sandbox. Se nenhum intervalo IP for definido, todos os IPs serão permitidos por padrão, e a resposta retornará uma lista vazia em allowedIpRanges.

Formato da API

GET /security/ip-access

Solicitação

curl -X GET https://platform.adobe.io/data/foundation/queryauth/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com uma lista dos intervalos IP permitidos da sandbox.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "allowedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "101.10.1.1"}
  ]
}

A tabela a seguir fornece uma descrição e um exemplo das propriedades do schema de resposta:

Propriedade
Descrição
Exemplo
imsOrg
ID da organização para a sandbox.
{ORG_ID}
sandboxName
Nome da sandbox à qual se aplicam restrições de IP.
prod
channel
O modo de acesso para restrições de IP. Atualmente, o único valor aceito é data_distiller. Esse valor significa que as restrições de IP são aplicadas às conexões PSQL ou JDBC.
data_distiller
allowedIpRanges
Lista de IPs permitidos no formato CIDR ou IP fixo. Cada entrada pode incluir uma descrição opcional.
[{"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"}]
NOTE
O campo allowedIpRanges pode incluir dois tipos de especificações de IP:
  • CIDR: notação CIDR padrão (por exemplo, "136.23.110.0/23") para definir intervalos IP.
  • IPs Corrigidos: IPs Simples para permissões de acesso individuais (por exemplo, "101.10.1.1").

Definir novos intervalos de IP

Substitua os intervalos IP existentes definindo uma nova lista para a sandbox. Esta operação requer uma lista completa de intervalos IP, incluindo todos que permanecem inalterados.

Formato da API

PUT /security/ip-access

Solicitação

curl -X PUT https://platform.adobe.io/data/foundation/queryauth/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
     "ipRanges": [
       {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
       {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
       {"ipRange": "101.10.1.1"},
       {"ipRange": "163.77.30.9", "description": "Test server IP"}
     ]
   }'

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes dos intervalos IP recém-configurados.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "allowedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
    {"ipRange": "101.10.1.1"},
    {"ipRange": "163.77.30.9", "description": "Test server IP"}
  ]
}

Excluir intervalos de IP delete-ip-ranges

Remova todos os intervalos IP configurados para a sandbox. Essa ação exclui os intervalos IP e retorna a lista IP excluída.

NOTE
A operação de exclusão se aplica à ID da organização (imsOrg) e afeta todos os intervalos IP configurados para a sandbox.

Formato da API

DELETE /security/ip-access

Solicitação

curl -X DELETE https://platform.adobe.io/data/foundation/queryauth/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes dos intervalos IP excluídos.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "deletedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
    {"ipRange": "101.10.1.1"},
    {"ipRange": "163.77.30.9", "description": "Test server IP"}
  ]
}
recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb