Share via


Tutorial: trabalhar com registros de dados do Petrel usando APIs do Petrel DDMS

Use as APIs de Serviços de Gerenciamento de Dados de Domínio do Petrel (DDMS) para trabalhar com dados do Petrel em sua instância do Gerenciador de Dados de Energia do Azure.

Neste tutorial, você aprenderá a:

  • Configure o Postman para usar uma coleção do Petrel DDMS.
  • Configure o Postman para usar um ambiente do Petrel DDMS.
  • Enviar solicitações por meio do Postman.
  • Gerar um token de autorização.
  • Use as APIs do Petrel DDMS para trabalhar com registros de dados e projetos do Petrel.

Para obter mais informações sobre DDMS, consulte os conceitos de DDMS.

Pré-requisitos

Obter os detalhes da instância do Gerenciador de Dados de Energia do Azure

A primeira etapa é obter as seguintes informações da instância do Gerenciador de Dados de Energia do Azure no portal do Azure:

Parâmetro Valor Exemplo
CLIENT_ID ID do aplicativo (cliente) 3dfxxxxxxxxxxxxxxxxxxxxxx
CLIENT_SECRET Segredos do cliente _fl******************
TENANT_ID ID do diretório (locatário) 72fxxxxxxxxxxxx
SCOPE ID do aplicativo (cliente) 3dfxxxxxxxxxxxxxxxxxxxxxxx
HOSTNAME URI <instance>.energy.azure.com
DATA_PARTITION_ID Partições de dados <instance>-<data-partition-name>

Você usará essa informação mais adiante neste tutorial.

Configurar o Postman

  1. Baixe e instale o aplicativo da área de trabalho Postman.

  2. Importe o seguinte arquivo no Postman: Petrel DDMS Postman collection.

  3. Crie um ambiente do Postman usando os valores obtidos anteriormente. O ambiente deve ficar parecido com este exemplo:

    Screenshot that shows an example Postman environment.

Gerar um token para ser usado em APIs

A coleção Postman do Petrel DDMS contém solicitações que você pode usar para interagir com projetos do Petrel. Ela também contém uma solicitação para consultar os projetos e registros atuais do Petrel em sua instância do Azure Data Manager for Energy.

  1. No Postman, no menu à esquerda, selecione Coleções e, em seguida, selecione Petrel DDMS. Em Configuração, selecione Obter Token.

  2. Na lista de seleção do ambiente no canto superior direito, selecione o Ambiente do Petrel DDMS.

  3. Para enviar a solicitação, selecione Enviar.

Essa solicitação irá gerar um token de acesso e o atribuirá como o método de autorização para solicitações futuras.

Você também pode gerar um token usando o comando cURL no Postman ou um terminal para gerar um token de portador. Use os valores da instância do Gerenciador de Dados de Energia do Azure.

      curl --location --request POST 'https://login.microsoftonline.com/{{TENANT_ID}}/oauth2/v2.0/token' \
          --header 'Content-Type: application/x-www-form-urlencoded' \
          --data-urlencode 'grant_type=client_credentials' \
          --data-urlencode 'client_id={{CLIENT_ID}}' \
          --data-urlencode 'client_secret={{CLIENT_SECRET}}' \
          --data-urlencode 'scope={{SCOPE}}'  

Para usar esse token gerado pelo cURL, atualize access_token em suas variáveis Collection com o valor que vem depois de Bearer na resposta.

Usar as APIs do Petrel DDMS para trabalhar com projetos do Petrel

Concluir com êxito as solicitações do Postman descritas nas seguintes APIs do Petrel DDMS indica uma interação bem-sucedida com seus projetos salvos do Petrel. Embora a API forneça uma maneira de carregar dados, recomendamos que você carregue seus projetos por meio do DELFI Petrel Project Explorer. Todas as chamadas à API a seguir pressupõem que você tenha um projeto carregado no Petrel Project Explorer.

Crie uma marca legal que é adicionada automaticamente ao ambiente do Petrel DDMS para conformidade de dados.

API: Configuração>Criar Marca Legal para PDS

Método: POST

Screenshot that shows the API that creates a legal tag.

Para obter mais informações, confira Gerenciar marcas legais.

Adicionar usuários a um grupo de direitos

Para que os usuários tenham as permissões adequadas para fazer chamadas à API do Petrel DDMS, eles devem fazer parte do grupo de direitos users.datalake.admins@{data-partition-id}.dataservices.energy. Essa chamada adiciona um usuário ao grupo apropriado.

O usuário nesse caso é a ID do cliente ou OID contida no token que é usado para autenticação. Por exemplo, se você gerar um token usando uma ID do cliente de 8cdxxxxxxxxxxxx, deverá adicionar 8cdxxxxxxxxxxxx ao grupo users.datalake.admins.

API: Configuração>Adicionar Usuário aos Administradores do DATALAKE

Método: POST

Screenshot that shows the API that adds user to entitlements.

Obter um projeto

Use uma ID de projeto para retornar o registro correspondente do projeto do Petrel em sua instância do Gerenciador de Dados de Energia do Azure.

API: Projeto>Obter Projeto

Método: GET

Screenshot that shows the API that gets a project.

Excluir um projeto

Use uma ID de projeto para excluir um projeto e os dados de registro do projeto do Petrel associados em sua instância do Gerenciador de Dados de Energia do Azure.

API: Projeto>Excluir Projeto

Método: DELETE

Screenshot that shows the API that deletes a project.

Obter uma versão do projeto

Use uma ID de projeto e uma ID de versão para obter o registro de versão do Petrel associado ao projeto e à versão em sua instância do Gerenciador de Dados de Energia do Azure.

API: Projeto>Obter Versão do Projeto

Método: GET

Screenshot that shows the API that gets a project version.

Obter uma URL de download do projeto

Use uma ID de projeto para obter uma URL de SAS (assinatura de acesso compartilhado) para que você possa baixar os dados do projeto correspondente de sua instância do Gerenciador de Dados de Energia do Azure.

API: Projeto>Obter Download do Projeto

Método: GET

Screenshot that shows the API that gets a project download URL.

Obter uma URL de carregamento do projeto

Use uma ID de projeto para obter duas URLs de SAS. Uma URL carrega dados para o projeto correspondente em sua instância do Gerenciador de Dados de Energia do Azure. A outra URL baixa dados do projeto correspondente na instância do Gerenciador de Dados de Energia do Azure.

API: Projeto>Obter URL de Carregamento Assinado

Método: POST

Screenshot that shows the API that gets a project upload URL.

A URL de carregamento da SAS deve ser semelhante a este exemplo:

https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}?{SAS-token-info}

Você pode modificar essa URL para conter o nome de arquivo dos dados que deseja carregar:

https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}/{FILENAME}?{SAS-token-info}

Fazer uma chamada PUT para essa URL carrega o conteúdo de body para o armazenamento de blobs sob o valor FILENAME fornecido.

Atualizar um projeto

Use uma ID de projeto e uma URL de carregamento de SAS para atualizar um registro de projeto do Petrel no Gerenciador de Dados de Energia do Azure com os novos valores. Você também pode carregar dados em um projeto, se desejar.

API: Projeto>Atualizar Projeto

Método: PUT

Screenshot that shows the API that updates a project.

Pesquisar projetos

Você pode pesquisar projetos do Petrel usando muitos campos. A chamada retorna todas as IDs de projeto correspondentes. A API dá suporte para o seguinte:

  • Pesquisa de texto completo em campos de cadeia de caracteres.
  • Intervalo de consultas com base em campos de data, numérico ou de cadeia de caracteres.
  • Pesquisa geoespacial.

API: Projeto>Pesquisar Projetos

Método: POST

Screenshot that shows the API that deletes a well record.

Use os seguintes links DELFI para ler outros tutoriais que envolvem fluxos de trabalho do Petrel e do Pretel Project Explorer: