Samouczek: praca z rekordami danych Petrel przy użyciu interfejsów API petrel DDMS

Artykuł
02/02/2024

Użyj interfejsów API usługi Zarządzanie danymi Domain Zarządzanie danymi Services (DDMS) Petrel w narzędziu Postman, aby pracować z danymi Petrel w twoim wystąpieniu usługi Azure Data Manager for Energy.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

Skonfiguruj narzędzie Postman do korzystania z kolekcji Petrel DDMS.
Skonfiguruj narzędzie Postman do korzystania ze środowiska Petrel DDMS.
Wysyłanie żądań za pośrednictwem narzędzia Postman.
Generowanie tokenu autoryzacji.
Interfejsy API petrel DDMS umożliwiają pracę z rekordami i projektami danych Petrel.

Aby uzyskać więcej informacji na temat DDMS, zobacz Pojęcia dotyczące DDMS.

Wymagania wstępne

Subskrypcja platformy Azure
Wystąpienie usługi Azure Data Manager for Energy utworzone w ramach subskrypcji platformy Azure

Uzyskiwanie szczegółów wystąpienia usługi Azure Data Manager dla wystąpienia energii

Pierwszym krokiem jest uzyskanie następujących informacji z wystąpienia usługi Azure Data Manager for Energy w witrynie Azure Portal:

Parametr	Wartość	Przykład
`CLIENT_ID`	Identyfikator aplikacji (klient)	`3dfxxxxxxxxxxxxxxxxxxxxxx`
`CLIENT_SECRET`	Klucze tajne klienta	`_fl******************`
`TENANT_ID`	Identyfikator katalogu (dzierżawcy)	`72fxxxxxxxxxxxx`
`SCOPE`	Identyfikator aplikacji (klient)	`3dfxxxxxxxxxxxxxxxxxxxxxxx`
`HOSTNAME`	Identyfikator URI	`<instance>.energy.azure.com`
`DATA_PARTITION_ID`	Partycje danych	`<instance>-<data-partition-name>`

Te informacje będą używane w dalszej części tego samouczka.

Konfigurowanie narzędzia Postman

Pobierz i zainstaluj aplikację klasyczną Postman .
Zaimportuj następujący plik w kolekcji Postman: Petrel DDMS Postman.
Utwórz środowisko Postman przy użyciu uzyskanych wcześniej wartości. Środowisko powinno wyglądać mniej więcej tak:

Generowanie tokenu do użycia w interfejsach API

Kolekcja Postman dla petrel DDMS zawiera żądania, których można użyć do interakcji z projektami Petrel. Zawiera również żądanie wykonywania zapytań dotyczących bieżących projektów Petrel i rekordów w wystąpieniu usługi Azure Data Manager for Energy.

W narzędziu Postman w menu po lewej stronie wybierz pozycję Kolekcje, a następnie wybierz pozycję Petrel DDMS. W obszarze Konfiguracja wybierz pozycję Pobierz token.
Na liście rozwijanej środowiska w prawym górnym rogu wybierz pozycję Petrel DDMS Environment.
Aby wysłać żądanie, wybierz pozycję Wyślij.

To żądanie generuje token dostępu i przypisuje go jako metodę autoryzacji dla przyszłych żądań.

Token można również wygenerować przy użyciu polecenia cURL w narzędziu Postman lub terminalu w celu wygenerowania tokenu elementu nośnego. Użyj wartości z wystąpienia usługi Azure Data Manager for Energy.

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

Aby użyć tego tokenu wygenerowanego przez bibliotekę cURL, musisz zaktualizować access_token zmienne Collection przy użyciu wartości po Bearer w odpowiedzi.

Korzystanie z interfejsów API programu Petrel DDMS do pracy z projektami Petrel

Pomyślne ukończenie żądań Postman opisanych w następujących interfejsach API petrel DDMS wskazuje na pomyślną interakcję z zapisanymi projektami Petrel. Mimo że interfejs API umożliwia przekazywanie danych, zalecamy przekazanie projektów za pośrednictwem Eksploratora projektów DELFI Petrel. Wszystkie poniższe wywołania interfejsu API zakładają, że projekt został przekazany do Eksploratora projektu Petrel.

Tworzenie tagu prawnego

Utwórz tag prawny, który jest automatycznie dodawany do środowiska Petrel DDMS w celu zapewnienia zgodności danych.

Interfejs API: Konfigurowanie>tworzenia tagu prawnego dla pdS

Metoda: POST

Aby uzyskać więcej informacji, zobacz Zarządzanie tagami prawnymi.

Dodawanie użytkowników do grupy uprawnień

Aby użytkownicy mieli odpowiednie uprawnienia do tworzenia wywołań interfejsu users.datalake.admins@{data-partition-id}.dataservices.energy API petrel DDMS, muszą być częścią grupy uprawnień. To wywołanie dodaje użytkownika do odpowiedniej grupy.

Użytkownik w tym przypadku jest identyfikatorem klienta lub identyfikatorem OID w tokenie używanym do uwierzytelniania. Jeśli na przykład wygenerujesz token przy użyciu identyfikatora 8cdxxxxxxxxxxxxklienta klasy , musisz dodać 8cdxxxxxxxxxxxx go do users.datalake.admins grupy.

INTERFEJS API: Konfigurowanie dodawania>użytkownika do Administracja DATALAKE

Metoda: POST

Pobieranie projektu

Użyj identyfikatora projektu, aby zwrócić odpowiedni rekord projektu Petrel w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: Project Get Project>

Metoda: GET

Usuń projekt

Użyj identyfikatora projektu, aby usunąć projekt i skojarzone dane rekordu projektu Petrel w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: Project Delete Project>

Metoda: DELETE

Pobieranie wersji projektu

Użyj identyfikatora projektu i identyfikatora wersji, aby uzyskać rekord wersji Petrel skojarzony z projektem i wersją w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: Project Get Project Version (Interfejs API: Project Get Project Version)>

Metoda: GET

Pobieranie adresu URL pobierania projektu

Użyj identyfikatora projektu, aby uzyskać adres URL sygnatury dostępu współdzielonego (SAS), aby pobrać dane odpowiedniego projektu z wystąpienia usługi Azure Data Manager for Energy.

Interfejs API: Pobieranie projektu>

Metoda: GET

Pobieranie adresu URL przekazywania projektu

Użyj identyfikatora projektu, aby uzyskać dwa adresy URL sygnatur dostępu współdzielonego. Jeden adres URL przekazuje dane do odpowiedniego projektu w wystąpieniu usługi Azure Data Manager for Energy. Drugi adres URL pobiera dane z odpowiedniego projektu w wystąpieniu usługi Azure Data Manager for Energy.

Interfejs API: Adres URL przekazywania podpisanego projektu>

Metoda: POST

Adres URL przekazywania sygnatury dostępu współdzielonego powinien wyglądać mniej więcej tak:

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

Możesz zmodyfikować ten adres URL tak, aby zawierał nazwę pliku danych, które chcesz przekazać:

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

PUT Wywołanie tego adresu URL powoduje przekazanie zawartości body do magazynu obiektów blob pod podaną FILENAME wartością.

Aktualizacja projektu

Użyj identyfikatora projektu i adresu URL przekazywania sygnatury dostępu współdzielonego, aby zaktualizować rekord projektu Petrel w usłudze Azure Data Manager for Energy przy użyciu nowych wartości. Możesz również przekazać dane do projektu, jeśli chcesz.

Interfejs API: Project Update Project>

Metoda: PUT

Wyszukiwanie w projektach

Możesz przeszukiwać projekty Petrel przy użyciu wielu pól. Wywołanie zwraca wszystkie pasujące identyfikatory projektów. Interfejs API obsługuje:

Wyszukiwanie pełnotekstowe w polach ciągów.
Zakres zapytań opartych na polach daty, liczbowych lub ciągów.
Wyszukiwanie geoprzestrzenne.

Interfejs API: Projekty wyszukiwania projektów>

Metoda: POST

Skorzystaj z poniższych linków DELFI, aby przeczytać inne samouczki obejmujące przepływy pracy Eksploratora projektów Petrel i Petrel:

Udostępnij za pośrednictwem

Samouczek: praca z rekordami danych Petrel przy użyciu interfejsów API petrel DDMS

Wymagania wstępne

Uzyskiwanie szczegółów wystąpienia usługi Azure Data Manager dla wystąpienia energii

Konfigurowanie narzędzia Postman

Generowanie tokenu do użycia w interfejsach API