Tutorial: Bekerja dengan rekaman data Petrel dengan menggunakan API Petrel DDMS
Gunakan API Petrel Domain Data Management Services (DDMS) di Postman untuk bekerja dengan data Petrel dalam instans Azure Data Manager for Energy Anda.
Dalam tutorial ini, Anda akan mempelajari cara:
- Siapkan Postman untuk menggunakan koleksi Petrel DDMS.
- Siapkan Postman untuk menggunakan lingkungan Petrel DDMS.
- Kirim permintaan melalui Postman.
- Membuat token otorisasi.
- Gunakan API DDMS Petrel untuk bekerja dengan rekaman dan proyek data Petrel.
Untuk informasi selengkapnya tentang DDMS, lihat konsep DDMS.
Prasyarat
- Langganan Azure
- Instans Azure Data Manager for Energy yang dibuat di langganan Azure Anda
Mendapatkan detail instans Azure Data Manager for Energy Anda
Langkah pertama adalah mendapatkan informasi berikut dari instans Azure Data Manager for Energy Anda di portal Azure:
| Parameter | Value | Contoh |
|---|---|---|
CLIENT_ID |
Aplikasi (ID klien) | 3dfxxxxxxxxxxxxxxxxxxxxxx |
CLIENT_SECRET |
Rahasia klien | _fl****************** |
TENANT_ID |
ID (tenant) direktori | 72fxxxxxxxxxxxx |
SCOPE |
Aplikasi (ID klien) | 3dfxxxxxxxxxxxxxxxxxxxxxxx |
HOSTNAME |
URI | <instance>.energy.azure.com |
DATA_PARTITION_ID |
Partisi data | <instance>-<data-partition-name> |
Anda akan menggunakan informasi ini nanti dalam tutorial.
Menyiapkan Postman
Unduh dan instal aplikasi desktop Postman .
Impor file berikut di Postman: Koleksi Petrel DDMS Postman.
Buat lingkungan Postman dengan menggunakan nilai yang Anda peroleh sebelumnya. Lingkungan akan terlihat seperti contoh ini:
Membuat token yang akan digunakan dalam API
Koleksi Postman untuk Petrel DDMS berisi permintaan yang dapat Anda gunakan untuk berinteraksi dengan proyek Petrel Anda. Ini juga berisi permintaan untuk mengkueri proyek dan rekaman Petrel saat ini di instans Azure Data Manager for Energy Anda.
Di Postman, di menu sebelah kiri, pilih Koleksi, lalu pilih Petrel DDMS. Di bawah Penyetelan, pilih Dapatkan Token.
Di daftar dropdown lingkungan di sudut kanan atas, pilih Lingkungan DDMS Petrel.
Untuk mengirim permintaan, pilih Kirim.
Permintaan ini menghasilkan token akses dan menetapkannya sebagai metode otorisasi untuk permintaan di masa mendatang.
Anda juga dapat menghasilkan token dengan menggunakan perintah cURL di Postman atau terminal untuk menghasilkan token pembawa. Gunakan nilai dari Instans Azure Data Manager for Energy Anda.
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}}'
Untuk menggunakan token yang dihasilkan cURL ini, Anda harus memperbarui access_token variabel Anda Collection dengan nilai setelah Bearer dalam respons.
Menggunakan API Petrel DDMS untuk bekerja dengan proyek Petrel
Berhasil menyelesaikan permintaan Postman yang dijelaskan dalam API Petrel DDMS berikut menunjukkan interaksi yang berhasil dengan proyek Petrel anda yang disimpan. Meskipun API menyediakan cara untuk mengunggah data, kami sarankan Anda mengunggah proyek anda melalui DELFI Petrel Project Explorer. Semua panggilan API berikut mengasumsikan bahwa Anda memiliki proyek yang diunggah ke Petrel Project Explorer.
Membuat tag hukum
Buat tag hukum yang secara otomatis ditambahkan ke lingkungan Petrel DDMS Anda untuk kepatuhan data.
API: Penyiapan>Buat Tag Hukum untuk PDS
Metode: POST
Untuk informasi selengkapnya, lihat Mengelola tag hukum.
Menambahkan pengguna ke grup pemberian izin
Agar pengguna memiliki izin yang tepat untuk melakukan panggilan API Petrel DDMS, mereka harus menjadi bagian users.datalake.admins@{data-partition-id}.dataservices.energy dari grup pemberian hak. Panggilan ini menambahkan pengguna ke grup yang tepat.
Pengguna dalam hal ini adalah ID klien atau OID dalam token yang digunakan untuk autentikasi. Misalnya, jika Anda membuat token dengan menggunakan ID klien , 8cdxxxxxxxxxxxxAnda harus menambahkan 8cdxxxxxxxxxxxx ke users.datalake.admins grup.
API: Menyiapkan>Tambahkan Pengguna ke Admin DATALAKE
Metode: POST
Mendapatkan proyek
Gunakan ID proyek untuk mengembalikan catatan proyek Petrel yang sesuai di instans Azure Data Manager for Energy Anda.
API: Proyek>Dapatkan Proyek
Metode: GET
Menghapus proyek
Gunakan ID proyek untuk menghapus proyek dan data rekaman proyek Petrel terkait di Instans Azure Data Manager for Energy Anda.
API: Proyek Penghapusan Proyek>
Metode: DELETE
Mendapatkan versi proyek
Gunakan ID proyek dan ID versi untuk mendapatkan rekaman versi Petrel yang terkait dengan proyek dan versi di instans Azure Data Manager for Energy Anda.
API: Versi Project>Get Project
Metode: GET
Mendapatkan URL unduhan proyek
Gunakan ID proyek untuk mendapatkan URL tanda tangan akses bersama (SAS) sehingga Anda dapat mengunduh data proyek yang sesuai dari Instans Azure Data Manager for Energy Anda.
API: Project>Get Project Download
Metode: GET
Mendapatkan URL pengunggahan proyek
Gunakan ID proyek untuk mendapatkan dua URL SAS. Satu URL mengunggah data ke proyek yang sesuai di Instans Azure Data Manager for Energy Anda. URL lainnya mengunduh data dari proyek yang sesuai di Instans Azure Data Manager for Energy Anda.
API: URL Unggahan Project>Get Signed
Metode: POST
URL unggahan SAS Anda akan terlihat seperti contoh ini:
https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}?{SAS-token-info}
Anda dapat mengubah URL ini untuk berisi nama file data yang ingin Anda unggah:
https://{storage-account}.z15.blob.storage.azure.net/projects/{data-partition-id}/{projectID}.staging/{versionID}/{FILENAME}?{SAS-token-info}
Melakukan PUT panggilan ke URL ini mengunggah konten body ke penyimpanan blob di bawah nilai yang disediakan FILENAME .
Memperbarui proyek
Gunakan ID proyek dan URL pengunggahan SAS untuk memperbarui rekaman proyek Petrel di Azure Data Manager for Energy dengan nilai baru. Anda juga dapat mengunggah data ke proyek jika mau.
API: Proyek Pembaruan Proyek>
Metode: PUT
Mencari melalui proyek
Anda dapat mencari melalui proyek Petrel dengan menggunakan banyak bidang. Panggilan mengembalikan semua ID proyek yang cocok. API mendukung:
- Pencarian teks lengkap pada bidang string.
- Kueri rentang berdasarkan bidang tanggal, numerik, atau string.
- Pencarian geospasial.
API: Proyek Pencarian Proyek>
Metode: POST
Konten terkait
Gunakan tautan DELFI berikut untuk membaca tutorial lain yang melibatkan alur kerja Petrel Project Explorer dan Petrel: