Udostępnij za pośrednictwem

interfejsy API modelu Azure Time Series Insights Gen2

  • Artykuł

Omówienie

Każdy z trzech składników, które tworzą model szeregów czasowych (wystąpienia, hierarchie i typy) mają odpowiednie interfejsy API REST, które obsługują operacje CREATE, READ, UPDATE i DELETE, podzielone na strony i/lub wsadowe.

  • Interfejs API wystąpienia obsługuje operacje GET z podziałem na strony, operacje tworzenia wsadowego, odczytu, aktualizacji i usuwania , wyszukiwania i słów kluczowych sugestii dotyczących operacji wyszukiwania.
  • Interfejs API hierarchii obsługuje operacje GET podzielone na strony oraz operacje CREATE, READ, UPDATE i DELETE .
  • Interfejs API typu obsługuje operacje GET podzielone na strony i operacje BATCH CREATE, READ, UPDATE i DELETE .

Czwarty interfejs API zapewnia obsługę rest ustawień modelu szeregów czasowych:

  • Interfejs API ustawień modelu obsługuje operacje HTTP GET i UPDATE dla ustawień konfiguracji modelu szeregów czasowych. Przeczytaj model szeregów czasowych , aby uzyskać szczegółowe informacje o modelu i wystąpieniu szeregów czasowych, hierarchii i definicjach typów .

Interfejs API wystąpień

Interfejs API wystąpień umożliwia wykonywanie operacji CREATE, READ, UPDATE i DELETE w wystąpieniach szeregów czasowych:

  • Interfejs API pobierania wystąpień zwraca wszystkie wystąpienia szeregów czasowych, które są zgodne z żądaniem.

  • Interfejs API zarządzania wystąpieniami umożliwia wykonywanie operacji wsadowych na wystąpieniach. Wszystkie operacje na tym interfejsie API to operacje HTTP POST . Każda operacja akceptuje ładunek. Ładunek jest obiektem JSON. Ten obiekt definiuje jedną właściwość. Klucz właściwości to nazwa operacji dozwolonej przez interfejs API. Obsługiwane operacje to PUT, UPDATE i DELETE.

  • Te interfejsy API umożliwiają odnajdywanie wystąpień szeregów czasowych:

    • Sugerowanie włączy scenariusze autouzupełniania podczas wyszukiwania wystąpienia.
    • Wyszukiwanie pomaga zidentyfikować wystąpienia na podstawie podanych słów kluczowych.

    Porada

    Przeczytaj o funkcjach zapytań wyszukiwania poniżej.

Interfejs API hierarchii

Interfejs API hierarchii umożliwia tworzenie, odczytywanie, aktualizowanie i usuwanie w hierarchiach szeregów czasowych.

Interfejs API Opis
Uzyskiwanie interfejsu API hierarchii Zwraca wszystkie hierarchie szeregów czasowych, które pasują do żądania.
Zarządzanie interfejsami API hierarchii Włącza operacje wsadowe w hierarchiach. Wszystkie operacje na tym interfejsie API to operacje HTTP POST . Każda operacja akceptuje ładunek. Ładunek jest obiektem JSON. Ten obiekt definiuje jedną właściwość. Klucz właściwości to nazwa operacji, którą zezwala interfejs API. Obsługiwane operacje to PUT, UPDATE i DELETE.

Interfejs API typów

Interfejs API typów umożliwia tworzenie, odczytywanie, aktualizowanie i usuwanie w typach szeregów czasowych i skojarzonych ze nimi zmiennych.

Interfejs API Opis
Uzyskiwanie interfejsu API typów Zwraca wszystkie typy szeregów czasowych i skojarzone ze nimi zmienne.
Interfejs API typów postów Umożliwia wykonywanie operacji wsadowych na typach. Wszystkie operacje na tym interfejsie API to operacje HTTP POST . Każda operacja akceptuje ładunek. Ładunek jest obiektem JSON. Ten obiekt definiuje jedną właściwość. Klucz właściwości to nazwa operacji, którą zezwala interfejs API. Obsługiwane operacje to PUT, UPDATE i DELETE.

Interfejs API ustawień modelu

Interfejs API ustawień modelu umożliwia tworzenie,odczytywanie, aktualizowanie i usuwanie automatycznie tworzonych modeli w środowisku według identyfikatorów TimeSeriesId.

Interfejs API Opis
Uzyskiwanie interfejsu API ustawień modelu Zwraca automatycznie utworzony model w środowisku dla identyfikatorów TimeSeriesIds.
Aktualizowanie interfejsu API ustawień modelu Aktualizacje model w środowisku timeSeriesIds z nowymi wartościami podanymi w żądaniu.

Funkcje wyszukiwania

Wyszukiwanie symboli wieloznacznych

Obsługujemy wyszukiwanie pojedynczych i wielu symboli wieloznacznych w ramach pojedynczych terminów (nie w wyszukiwaniu fraz).

Pojedynczy znak

Aby wykonać wyszukiwanie symboli wieloznacznych pojedynczego znaku, użyj symbolu ? . Wyszukiwanie symboli wieloznacznych pojedynczego znaku szuka terminów pasujących do ciągu z zastąpionym pojedynczym znakiem.

Aby wyszukać ciąg text lub test, wyszukaj: te?t.

Wiele znaków

Aby wykonać wyszukiwanie wieloznaczne z wieloma znakami, użyj symbolu * . Wyszukiwanie symboli wieloznacznych wielu znaków szuka zera lub większej liczby znaków.

Aby wyszukać testciąg , testslub tester, użyj wyszukiwania: test*.

Możesz również użyć wyszukiwania symboli wieloznacznych w środku terminu. Aby wyszukać dryerciąg , możesz użyć wyszukiwania: dr*r.

Operatory logiczne

Operatory logiczne umożliwiają łączenie terminów za pomocą operatorów logiki. Obsługujemy operatory LOGICZNE AND, OR, +, -i NOT jako operatory logiczne.

Ważne

  • Operatory logiczne muszą znajdować się we wszystkich CAPS.
  • Operatory logiczne muszą być oddzielone od klauzul wyszukiwania przy użyciu białych spacji.
  • dryer AND washer jest prawidłowy, ale nie dryer ANDwasher.

AND Operator

Operator AND pasuje do dokumentów, w których oba terminy istnieją w dowolnym miejscu w tekście pojedynczego dokumentu.

Aby wyszukać dokumenty zawierające dryer washer i foo bar użyć wyszukiwania: dryer washer AND foo bar.

Uwaga

&& Symbol może być używany zamiast operatora AND.

OR Operator

Operator OR łączy dwa terminy i znajduje pasujący dokument, jeśli któryś z terminów istnieje w dokumencie. Operator OR jest domyślnym operatorem połączenia. Oznacza to, że jeśli między dwoma terminami nie ma operatora logicznego, zostanie użyty operator OR .

Aby wyszukać dokumenty zawierające dryer washer lub po prostu dryer użyć jednego z następujących wyszukiwań:

  1. 'dryer washer' dryer
  2. 'dryer washer' OR dryer

Uwaga

|| Symbol można użyć zamiast operatora OR.

+ Operator

Operator + or required wymaga, aby termin po symbolu + istnieje gdzieś w polu pojedynczego dokumentu.

Aby wyszukać dokumenty, które muszą zawierać dryer i mogą zawierać washer wyszukiwanie: +dryer washer.

-Operator

Operator - or zakazuje dokumentów, które zawierają termin po symbolu - .

Aby wyszukać dokumenty zawierające dryer washer , ale nie foo bar należy używać wyszukiwania: dryer washer -foo bar.

NOT

Operator NOT wyklucza dokumenty zawierające termin po NOT.

Aby wyszukać dokumenty zawierające dryer washer , ale nie foo bar należy używać wyszukiwania: dryer washer NOT foo bar.

Operator NOT nie może być używany z tylko jednym terminem.

Następujące wyszukiwanie nie zwróci żadnych wyników: NOT dryer washer.

Uwaga

Symbol ! może być używany zamiast operatora NOT.

  • Musi natychmiast poprzedzać wykluczony termin wyszukiwania.
  • dryer !washer jest prawidłowy, ale nie dryer ! washer.

Zobacz też

  • Aby uzyskać więcej informacji na temat rejestracji aplikacji i modelu programowania usługi Azure Active Directory, zobacz Azure Active Directory dla deweloperów.

  • Aby dowiedzieć się więcej o parametrach żądania i uwierzytelniania, przeczytaj Uwierzytelnianie i autoryzacja.

  • Narzędzia, które pomagają w testowaniu żądań i odpowiedzi HTTP, obejmują:

  • Fiddler. Ten bezpłatny internetowy serwer proxy debugowania może przechwytywać żądania REST, dzięki czemu można zdiagnozować żądania HTTP i komunikaty odpowiedzi.

  • JWT.io. Za pomocą tego narzędzia można szybko zrzucić oświadczenia w tokenie elementu nośnego, a następnie zweryfikować ich zawartość.

  • Postman. Jest to bezpłatne narzędzie do testowania żądań HTTP i odpowiedzi na potrzeby debugowania interfejsów API REST.

  • Dowiedz się więcej o Azure Time Series Insights Gen2, przeglądając dokumentację usługi Gen2.