Jak wykonywać zapytania dotyczące interfejsów API usługi Azure Digital Twins pod kątem typowych zadań

Artykuł
02/24/2020

Ważne

Wydano nową wersję usługi Azure Digital Twins. W świetle rozszerzonych możliwości nowej usługi oryginalna usługa Azure Digital Twins (opisana w tym zestawie dokumentacji) została wycofana.

Aby wyświetlić dokumentację nowej usługi, odwiedź aktywną dokumentację usługi Azure Digital Twins.

W tym artykule przedstawiono wzorce zapytań ułatwiające wykonywanie typowych scenariuszy dla wystąpienia usługi Azure Digital Twins. Przyjęto założenie, że wystąpienie usługi Digital Twins jest już uruchomione. Możesz użyć dowolnego klienta REST, takiego jak Postman.

W poniższych YOUR_MANAGEMENT_API_URL przykładach odwołuje się do identyfikatora URI interfejsów API usługi Digital Twins:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0

Nazwa	Zamień na
YOUR_INSTANCE_NAME	Nazwa wystąpienia usługi Azure Digital Twins
YOUR_LOCATION	Region, w którym jest hostowane twoje wystąpienie

Zapytania dotyczące spacji i typów

W tej sekcji przedstawiono przykładowe zapytania, aby uzyskać więcej informacji o aprowizowanych miejscach. Wykonaj uwierzytelnione żądania HTTP GET przy użyciu przykładowych zapytań, zastępując symbole zastępcze wartościami z konfiguracji.

Pobieranie spacji, które są węzłami głównymi.

YOUR_MANAGEMENT_API_URL/spaces?$filter=ParentSpaceId eq null

Pobierz przestrzeń według nazwy i dołącz urządzenia, czujniki, obliczone wartości i wartości czujników.
```
YOUR_MANAGEMENT_API_URL/spaces?name=Focus Room A1&includes=fullpath,devices,sensors,values,sensorsvalues
```
Uzyskaj spacje i informacje o urządzeniu/czujniku, którego element nadrzędny jest podanym identyfikatorem przestrzeni i które znajdują się na poziomie od dwóch do pięciu względem danej przestrzeni.
```
YOUR_MANAGEMENT_API_URL/spaces?spaceId=YOUR_SPACE_ID&includes=fullpath,devices,sensors,values,sensorsvalues&traverse=Down&minLevel=1&minRelative=true&maxLevel=5&maxRelative=true
```

Pobierz miejsce z danym identyfikatorem i uwzględnij obliczone wartości czujników i .

YOUR_MANAGEMENT_API_URL/spaces?ids=YOUR_SPACE_ID&includes=Values,sensors,SensorsValues

Pobierz klucze właściwości dla określonego miejsca.

YOUR_MANAGEMENT_API_URL/propertykeys?spaceId=YOUR_SPACE_ID

Pobierz spacje z kluczem właściwości o nazwie AreaInSqMeters , a jego wartość to 30. Można również wykonywać operacje na ciągach, na przykład pobierać spacje zawierające klucz właściwości za pomocą polecenia name = X contains Y.
```
YOUR_MANAGEMENT_API_URL/spaces?propertyKey=AreaInSqMeters&propertyValue=30
```

Pobierz wszystkie nazwy o nazwie Temperature i skojarzone zależności oraz nalogie.

YOUR_MANAGEMENT_API_URL/types?names=Temperature&includes=space,ontologies,description,fullpath

Zapytania dotyczące ról i przypisań ról

W tej sekcji przedstawiono niektóre zapytania, aby uzyskać więcej informacji na temat ról i ich przypisań.

Uzyskaj wszystkie role obsługiwane przez usługę Azure Digital Twins.
```
YOUR_MANAGEMENT_API_URL/system/roles
```
Pobierz wszystkie przypisania ról w wystąpieniu usługi Digital Twins.
```
YOUR_MANAGEMENT_API_URL/roleassignments?path=/&traverse=down
```

Pobieranie przypisań ról w określonej ścieżce.

YOUR_MANAGEMENT_API_URL/roleassignments?path=/A_SPATIAL_PATH

Zapytania dotyczące urządzeń

W tej sekcji przedstawiono kilka przykładów używania interfejsów API zarządzania do uzyskiwania określonych informacji o urządzeniach. Wszystkie wywołania interfejsu API muszą być uwierzytelnione żądania HTTP GET.

Pobierz wszystkie urządzenia.
```
YOUR_MANAGEMENT_API_URL/devices
```

Znajdź wszystkie stany urządzeń.

YOUR_MANAGEMENT_API_URL/system/devices/statuses

Pobierz określone urządzenie.

YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_ID

Pobierz wszystkie urządzenia dołączone do przestrzeni głównej.
```
YOUR_MANAGEMENT_API_URL/devices?maxLevel=1
```
Pobierz wszystkie urządzenia dołączone do spacji na poziomach od 2 do 4.
```
YOUR_MANAGEMENT_API_URL/devices?minLevel=2&maxLevel=4
```
Pobierz wszystkie urządzenia bezpośrednio dołączone do określonego identyfikatora miejsca.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID
```
Pobierz wszystkie urządzenia dołączone do określonego miejsca i jego elementów podrzędnych.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down
```
Pobierz wszystkie urządzenia dołączone do obiektów potomnych spacji, z wyłączeniem tego miejsca.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&minLevel=1&minRelative=true
```

Pobierz wszystkie urządzenia dołączone do bezpośrednich elementów podrzędnych przestrzeni.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&minLevel=1&minRelative=true&maxLevel=1&maxRelative=true

Pobierz wszystkie urządzenia dołączone do jednego z przodków przestrzeni.

YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Up&maxLevel=-1&maxRelative=true

Pobierz wszystkie urządzenia dołączone do elementów potomnych przestrzeni, która jest mniejsza lub równa 5.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Down&maxLevel=5
```
Pobierz wszystkie urządzenia dołączone do spacji, które znajdują się na tym samym poziomie co miejsce z identyfikatorem YOUR_SPACE_ID.
```
YOUR_MANAGEMENT_API_URL/devices?spaceId=YOUR_SPACE_ID&traverse=Span&minLevel=0&minRelative=true&maxLevel=0&maxRelative=true
```

Pobierz parametry połączenia urządzenia IoT Hub dla urządzenia.

YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_ID?includes=ConnectionString

Pobierz urządzenie z danym identyfikatorem sprzętu, w tym dołączonymi czujnikami.

YOUR_MANAGEMENT_API_URL/devices?hardwareIds=YOUR_DEVICE_HARDWARE_ID&includes=sensors

Pobierz czujniki dla określonych typów danych, w tym przypadku ruch i temperatura.
```
YOUR_MANAGEMENT_API_URL/sensors?dataTypes=Motion,Temperature
```

Zapytania dotyczące funkcji matcherów i funkcji zdefiniowanych przez użytkownika

Pobierz wszystkie aprowizowane zgodnych elementów i ich identyfikatory.
```
  YOUR_MANAGEMENT_API_URL/matchers
```
Uzyskaj szczegółowe informacje na temat określonego elementu matcher, w tym skojarzonych z nim spacji i funkcji zdefiniowanej przez użytkownika.
```
YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_ID?includes=description, conditions, fullpath, userdefinedfunctions, space
```
Oceń element matcher względem czujnika i włącz rejestrowanie na potrzeby debugowania. Powrót tego komunikatu HTTP GET informuje o tym, czy element matcher i czujnik należą do typu danych.
```
  YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_ID/evaluate/YOUR_SENSOR_ID?enableLogging=true
```
Pobierz identyfikator funkcji zdefiniowanych przez użytkownika.
```
  YOUR_MANAGEMENT_API_URL/userdefinedfunctions
```

Pobieranie zawartości określonej funkcji zdefiniowanej przez użytkownika

  YOUR_MANAGEMENT_API_URL/userdefinedfunctions/YOUR_USER_DEFINED_FUNCTION_ID/contents

Zapytania dotyczące użytkowników

W tej sekcji przedstawiono przykładowe zapytania interfejsu API do zarządzania użytkownikami w usłudze Azure Digital Twins. Utwórz żądanie HTTP GET, zastępując symbole zastępcze wartościami z konfiguracji.

Pobierz wszystkich użytkowników.
```
YOUR_MANAGEMENT_API_URL/users
```

Pobierz określonego użytkownika.

YOUR_MANAGEMENT_API_URL/users/ANY_USER_ID

Następne kroki

Aby dowiedzieć się, jak uwierzytelniać się za pomocą interfejsu API zarządzania, przeczytaj Uwierzytelnianie za pomocą interfejsów API.

Aby dowiedzieć się więcej na temat punktów końcowych interfejsu API, przeczytaj artykuł How to use Digital Twins Swagger (Jak używać struktury Swagger usługi Digital Twins).

Udostępnij za pośrednictwem