Samouczek: używanie punktów końcowych interfejsu API protokołu WebSocket protokołu DDMS zbiorników
Użyj interfejsów API usługi Zarządzanie danymi Domain Zarządzanie danymi Services (DDMS) w programie PowerShell, aby pracować z danymi zbiorników w zasobie usługi Azure Data Manager for Energy.
Z tego samouczka dowiesz się, jak używać punktu końcowego protokołu Websocket dla rozwiązania Reservoir DDMS do wykonywania następujących zadań:
- Utwórz przestrzeń danych.
- Pobierz przestrzeń danych.
- Pozyskiwanie pliku EPC.
- Uzyskaj dostęp do pozyskanych danych.
- Usuń przestrzeń danych.
Aby uzyskać więcej informacji na temat DDMS, zobacz Pojęcia dotyczące DDMS.
Wymagania wstępne
- Zasób usługi Azure Data Manager for Energy utworzony w ramach subskrypcji platformy Azure
- Klient klasyczny platformy Docker powinien być uruchomiony w systemie
Konfigurowanie
Aby nawiązać połączenie z serwerem zdalnym za pośrednictwem usług WSS, potrzebny jest klient z obsługą protokołu ETP SSL. Pobierz klienta SSL przed kompilacją z rejestru kontenerów platformy 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
Postępuj zgodnie z instrukcjami generowania tokenu uwierzytelniania, aby utworzyć prawidłowy token uwierzytelniania. Ten token służy do uwierzytelniania wywołań na serwerze.
Ustaw następujące zmienne:
$RDDMS_URL='<adme_dns>/api/reservoir-ddms-etp/v2/' $PARTITION='<data_partition_name>' $TOKEN='<access_token>'
Korzystanie z punktów końcowych protokołu websocket
Utwórz przestrzeń danych:
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}
Pobierz przestrzeń danych:
docker run -it --rm open-etp:ssl-client openETPServer space -S wss://${RDDMS_URL} -l --data-partition-id ${PARTITION} --auth bearer --jwt-token ${TOKEN}
Pozyskiwanie pliku 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}
Uzyskaj dostęp do pozyskanych danych:
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}
Usuń przestrzeń danych:
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}