Partager via


Tutoriel : Utiliser des points de terminaison d’API websocket Reservoir DDMS

Utilisez les API Reservoir Domain Data Management Services (DDMS) dans PowerShell pour tirer parti des données de réservoir dans une ressource Azure Data Manager for Energy.

Dans ce tutoriel, vous allez apprendre à utiliser un point de terminaison websocket Reservoir DDMS pour :

  • Créer l’espace de données.
  • Obtenir l’espace de données.
  • Ingérer un fichier EPC.
  • Accéder aux données ingérées.
  • Supprimer l’espace de données.

Pour plus d’informations sur DDMS, consultez Concepts DDMS.

Prérequis

  • Une ressource Azure Data Manager for Energy créée dans votre abonnement Azure
  • Le client de bureau Docker doit s’exécuter sur votre système

Configuration

  1. Pour vous connecter à un serveur distant via WSS, vous avez besoin d’un client SSL ETP activé. Téléchargez un client SSL prédéfini à partir du registre de conteneurs Docker OSDU GitLab.

    export SSLCLIENT_IMAGE=community.opengroup.org:5555/osdu/platform/domain-data-mgmt-services/reservoir/open-etp-server/open-etp-sslclient-main
    docker pull ${SSLCLIENT_IMAGE}
    docker tag ${SSLCLIENT_IMAGE} open-etp:ssl-client
    
  2. Suivez Comment générer un jeton d’authentification pour créer un jeton d’authentification valide. Ce jeton est utilisé pour authentifier les appels au serveur.

  3. Définissez les variables suivantes :

    $RDDMS_URL='<adme_dns>/api/reservoir-ddms-etp/v2/'
    $PARTITION='<data_partition_name>'
    $TOKEN='<access_token>'
    

Utilisation des points de terminaison websocket

  1. Créez l’espace de données :

    docker run -it --rm open-etp:ssl-client openETPServer space -S wss://${RDDMS_URL} --new -s <data_space_name> --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN} --xdata "{\"viewers\":[\"data.default.viewers@<data_partition_name>.dataservices.energy\"],\"owners\":[\"data.default.owners@<data_partition_name>.dataservices.energy\"],\"legaltags\":\"<legal_tag_name>\",\"otherRelevantDataCountries\":[\"<country_code1\", \"country_code2\"]}"
    
  2. Obtenez l’espace de données :

    docker run -it --rm open-etp:ssl-client openETPServer space -S wss://${RDDMS_URL} -l --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN}
    
  3. Ingérez un fichier EPC :

    docker run -it --rm -v <path_to_directory_containing_epc_file>:/data open-etp:ssl-client openETPServer space -S wss://${RDDMS_URL} -s <dataspace_name> --import-epc ./data/<epc_file_name> --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN}
    
  4. Accédez aux données ingérées :

    docker run -it --rm open-etp:ssl-client openETPServer space -S wss://${RDDMS_URL} -s <dataspace_name> --stats --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN}
    
  5. Supprimez l’espace de données :

    docker run -it --rm open-etp:ssl-client openETPServer space --delete -S wss://${RDDMS_URL} -s <dataspace_name> --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN}