Руководство. Работа с записями данных Петреля с помощью API-интерфейсов Петреля DDMS

  • Статья

Используйте API-интерфейсы доменных Управление данными служб (DDMS) в Postman для работы с данными Петреля в вашем экземпляре Azure Data Manager для энергетики.

В этом руководстве описано следующее:

  • Настройте Postman для использования коллекции Petrel DDMS.
  • Настройте Postman для использования среды DDMS Петреля.
  • Отправка запросов через Postman.
  • Создайте маркер авторизации.
  • Используйте API-интерфейсы DDMS Петреля для работы с записями и проектами данных Петреля.

Дополнительные сведения о DDMS см . в концепциях DDMS.

Необходимые компоненты

Получение сведений об экземпляре Azure Data Manager для энергетики

Первым шагом является получение следующих сведений из экземпляра Azure Data Manager для энергии в портал Azure:

Параметр Значение Пример
CLIENT_ID Идентификатор приложения (клиент) 3dfxxxxxxxxxxxxxxxxxxxxxx
CLIENT_SECRET Секреты клиента _fl******************
TENANT_ID Идентификатор каталога (клиента) 72fxxxxxxxxxxxx
SCOPE Идентификатор приложения (клиент) 3dfxxxxxxxxxxxxxxxxxxxxxxx
HOSTNAME URI-адрес <instance>.energy.azure.com
DATA_PARTITION_ID Секции данных <instance>-<data-partition-name>

Эти сведения будут использоваться далее в руководстве.

Настройка Postman

  1. Скачайте и установите классическое приложение Postman .

  2. Импортируйте следующий файл в Postman: Коллекция Postman Для Петреля DDMS.

  3. Создайте среду Postman с помощью значений, полученных ранее. Среда должна выглядеть примерно так:

    Screenshot that shows an example Postman environment.

Создание маркера для использования в API

Коллекция Postman для DDMS Петреля содержит запросы, которые можно использовать для взаимодействия с проектами Петреля. Он также содержит запрос на запрос текущих проектов и записей Петреля в экземпляре Azure Data Manager для энергетики.

  1. В Postman в меню слева выберите "Коллекции" и выберите "Петрель DDMS". В разделе "Настройка" выберите "Получить маркер".

  2. В раскрывающемся списке среды в правом верхнем углу выберите "Среда Петреля DDMS".

  3. Чтобы отправить запрос, нажмите кнопку "Отправить".

Этот запрос создает маркер доступа и назначает его в качестве метода авторизации для будущих запросов.

Вы также можете создать токен с помощью команды cURL в Postman или терминале для создания маркера носителя. Используйте значения из экземпляра Azure Data Manager для энергетики.

      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}}'

Чтобы использовать этот маркер cURL, необходимо обновить access_token переменные Collection со значением после Bearer ответа.

Использование API-интерфейсов DDMS Petrel для работы с проектами Petrel

Успешное завершение запросов Postman, описанных в следующих API-интерфейсах Петреля DDMS, указывает на успешное взаимодействие с сохраненными проектами Петреля. Хотя API предоставляет способ отправки данных, рекомендуется отправлять проекты через DELFI Petrel Project Обозреватель. Все приведенные ниже вызовы API предполагают, что у вас есть проект, отправленный в Проект Петреля Обозреватель.

Создайте юридический тег, который автоматически добавляется в среду Petrel DDMS для соответствия данным.

API: настройка>создания юридического тега для PDS

Метод: POST

Screenshot that shows the API that creates a legal tag.

Дополнительные сведения см. в разделе "Управление юридическими тегами".

Добавление пользователей в группу прав

Чтобы пользователи имели соответствующие разрешения на вызовы API Петреля DDMS, они должны быть частью users.datalake.admins@{data-partition-id}.dataservices.energy группы прав. Этот вызов добавляет пользователя в соответствующую группу.

В этом случае пользователь является идентификатором клиента или OID в маркере, который используется для проверки подлинности. Например, если вы создаете маркер с помощью идентификатора 8cdxxxxxxxxxxxxклиента, необходимо добавить 8cdxxxxxxxxxxxx в группу users.datalake.admins .

API: настройка>добавления пользователя в Администратор DATALAKE

Метод: POST

Screenshot that shows the API that adds user to entitlements.

Получение проекта

Используйте идентификатор проекта, чтобы вернуть соответствующую запись проекта Петреля в экземпляре Azure Data Manager для энергетики.

API: Project Get Project>

Метод: GET

Screenshot that shows the API that gets a project.

Удаление проекта

Используйте идентификатор проекта для удаления проекта и связанных данных записи проекта Petrel в экземпляре Azure Data Manager для энергетики.

API: проект удаления проекта>

Метод: DELETE

Screenshot that shows the API that deletes a project.

Получение версии проекта

Используйте идентификатор проекта и идентификатор версии, чтобы получить запись версии Петреля, связанную с проектом и версией в экземпляре Azure Data Manager для энергетики.

API: версия project Get Project>

Метод: GET

Screenshot that shows the API that gets a project version.

Получение URL-адреса скачивания проекта

Используйте идентификатор проекта, чтобы получить URL-адрес подписанного URL-адреса url-адреса для общего доступа, чтобы скачать данные соответствующего проекта из экземпляра Azure Data Manager для энергетики.

API: Скачивание проекта>

Метод: GET

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

Получение URL-адреса отправки проекта

Используйте идентификатор проекта для получения двух URL-адресов SAS. Один URL-адрес отправляет данные в соответствующий проект в экземпляре Azure Data Manager для энергетики. Другой URL-адрес загружает данные из соответствующего проекта в экземпляре Azure Data Manager для энергетики.

API: URL-адрес отправки подписи проекта>

Метод: POST

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

URL-адрес отправки SAS должен выглядеть примерно так:

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

Этот URL-адрес можно изменить, чтобы он содержал имя файла данных, которые требуется отправить:

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

PUT Вызов этого URL-адреса отправляет содержимое body в хранилище BLOB-объектов в заданное FILENAME значение.

Обновление проекта

Используйте идентификатор проекта и URL-адрес отправки SAS для обновления записи проекта Петреля в Azure Data Manager для энергетики с новыми значениями. Вы также можете передать данные в проект, если вы хотите.

API: проект обновления проекта>

Метод: PUT

Screenshot that shows the API that updates a project.

Поиск по проектам

Вы можете искать проекты Петреля с помощью множества полей. Вызов возвращает все соответствующие идентификаторы проектов. API поддерживает следующее:

  • Полнотекстовый поиск по строковым полям.
  • Запросы диапазона, основанные на дате, числовых или строковых полях.
  • Геопространственный поиск.

API: проекты поиска проектов>

Метод: POST

Screenshot that shows the API that deletes a well record.

Связанный контент

Используйте следующие ссылки DELFI для чтения других учебников, включающих в себя рабочие процессы Петреля Проекта Обозреватель и Петреля: