Interfejsy API modelu usługi Azure Time Series Insights Gen2

Przegląd

Każdy z trzech składników, które tworzą model szeregów czasowych (wystąpienia, hierarchie i typy), ma 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 podzielone na strony, operacje wsadowe CREATE,READ, UPDATE i DELETE, sugestie dotyczące wyszukiwania i słów kluczowych dla operacji wyszukiwania.
• Interfejs API hierarchii obsługuje operacje GET podzielone na strony oraz operacje wsadowe CREATE,READ, UPDATE i DELETE.
• Interfejs API typów obsługuje operacje GET podzielone na strony oraz operacje wsadowe CREATE,READ, UPDATE i DELETE.

Czwarty interfejs API zapewnia obsługę interfejsu REST dla 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 na temat modelu szeregów czasowych oraz wystąpień, hierarchii i definicji typów .

Interfejs API instancji

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 instancjach. Wszystkie operacje na tym interfejsie API są operacjami HTTP POST . Każda operacja akceptuje ładunek. Ładunek jest obiektem JSON. Ten obiekt definiuje pojedynczą 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:

  • Sugeruj włączy scenariusze autouzupełniania podczas wyszukiwania instancji.
  • Wyszukiwanie pomaga w identyfikacji instancji na podstawie podanych słów kluczowych.

  Wskazówka

  Zapoznaj się z poniższymi funkcjami zapytań wyszukiwania .

Interfejs API hierarchii

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

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

Typy API

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

API	Opis
Interfejs API pobierania typów	Zwraca wszystkie typy szeregów czasowych i skojarzone z nimi zmienne.
Interfejs API typów postów	Umożliwia operacje wsadowe na typach. Wszystkie operacje na tym interfejsie API są operacjami HTTP POST . Każda operacja akceptuje ładunek. Ładunek jest obiektem JSON. Ten obiekt definiuje pojedynczą właściwość. Klucz właściwości to nazwa operacji, na 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 utworzonych modeli w środowisku według identyfikatorów TimeSeriesIds.

API	Opis
Pobieranie interfejsu API ustawień modelu	Zwraca automatycznie utworzony model w środowisku dla identyfikatorów TimeSeriesIds.
Interfejs API aktualizowania ustawień modelu	Aktualizuje model w środowisku dla identyfikatorów TimeSeriesIds przy użyciu nowych wartości podanych w żądaniu.

Funkcje wyszukiwania

Wyszukiwanie symboli wieloznacznych

Obsługujemy wyszukiwanie jedno- i wieloznakowe z symbolami wieloznacznymi w obrębie pojedynczych terminów (nie w obrębie wyszukiwanych fraz).

Pojedynczy znak

Aby przeprowadzić wyszukiwanie pojedynczych symboli wieloznacznych, użyj symbolu ? . Wyszukiwanie pojedynczych symboli wieloznacznych wyszukuje terminy pasujące do ciągu, a zastąpiony pojedynczy znak.

Aby wyszukać jeden lub texttestlub , szukaj: te?t.

Wiele znaków

Aby przeprowadzić wyszukiwanie wielu symboli wieloznacznych, należy użyć symbolu * . Wyszukiwania z wieloma symbolami wieloznacznymi wyszukują zero lub więcej znaków.

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

Możesz również użyć wyszukiwań z symbolami wieloznacznymi w środku terminu. Aby wyszukać dryer, możesz użyć wyszukiwania: dr*r.

Operatory logiczne

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

Ważne

• Operatory logiczne muszą być pisane WIELKIMI LITERAMI.
• Operatory logiczne muszą być oddzielone od klauzul wyszukiwania za pomocą białych znaków.
• dryer AND washer jest ważny, ale nie dryer ANDwasher.

AND Operator

Operator AND dopasowuje dokumenty, w których oba terminy występują w dowolnym miejscu w tekście pojedynczego dokumentu.

Aby wyszukać dokumenty, które zawierają dryer washer wyszukiwanie, i foo bar za pomocą tego szukania: dryer washer AND foo bar.

Uwaga / Notatka

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

OR Operator

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

Aby wyszukać dokumenty, które zawierają jedno dryer washer lub tylko dryer jedno z następujących wyszukiwań:

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

Uwaga / Notatka

Symbol || może być używany zamiast operatora OR.

+ Operator

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

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

-Operator

Operator - or zabronić wyklucza dokumenty, które zawierają termin po symbolu - .

Aby wyszukać dokumenty, które zawierają dryer washer , ale nie foo bar skorzystaj z funkcji wyszukiwania: dryer washer -foo bar.

NIE

Operator NOT wyklucza dokumenty, które zawierają termin po NOT.

Aby wyszukać dokumenty, które zawierają dryer washer , ale nie foo bar skorzystaj z funkcji wyszukiwania: dryer washer NOT foo bar.

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

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

Uwaga / Notatka

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

• Musi ono bezpośrednio poprzedzać wykluczone wyszukiwane hasło.
• dryer !washer jest ważny, ale nie dryer ! washer.

Zobacz także

• 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 artykuł Uwierzytelnianie i autoryzacja.

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

• Skrzypek. Ten bezpłatny serwer proxy do debugowania sieci Web może przechwytywać żądania REST, dzięki czemu można zdiagnozować komunikaty żądań i odpowiedzi HTTP.

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

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

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