Udostępnij przez

Interfejsy API zapytań usługi Azure Time Series Insights Gen2

Przegląd

Interfejsy API zapytań składają się z trzech interfejsów API REST, po jednym interfejsie API dla zdarzeń, serii i agregacji.

Interfejsy API zapytań zwracają schemat zdarzeń i liczbę zdarzeń w określonym zakresie czasu za pośrednictwem żądań HTTP GET z opcjonalną stronicowaniem. Informacje o seriach i zagregowanych seriach są również uwidaczniane za pośrednictwem operacji GET z opcjonalną stronicowaniem.

API Opis
Pobierz interfejs API zdarzeń Zwraca listę nieprzetworzonych zdarzeń, które pasują do zakresu wyszukiwania i predykatu.
Pobierz interfejs API serii Umożliwia wykonywanie zapytań i pobieranie danych usługi Time Series Insights z przechwyconych zdarzeń przy użyciu danych zarejestrowanych w sieci za pośrednictwem zmiennych zdefiniowanych w modelu lub dostarczonych w tekście.
Interfejs API agregacji serii Umożliwia wykonywanie zapytań i pobieranie danych usługi Time Series Insights z przechwyconych zdarzeń przez agregowanie zarejestrowanych danych przy użyciu funkcji agregujących lub przykładowych.

Interfejsy API obsługują również różne niestandardowe operacje określone za pośrednictwem treści JSON żądania HTTP. Definicje zapytań mogą być używane do typowych operacji.

Ważne

Odpowiedzi na błędy

Jeśli wykonanie zapytania zakończy się niepowodzeniem, ładunek odpowiedzi JSON będzie zawierał odpowiedź na błąd zgodną z następującą strukturą:

{
    "error" : {
        "code" : "...",
        "message" : "...",
        "innerError" : {  
            "code" : "...",
            "message" : "...",
        }
    }
}

innerError Tutaj jest opcjonalne. Oprócz podstawowych błędów, takich jak źle sformułowane żądanie, zwracane są następujące błędy:

Kod stanu HTTP Kod błędu Przykładowy komunikat o błędzie Możliwe kody błędów wewnętrznych
400 NiepoprawnaWersjaApi Wersja interfejsu API "2016" nie jest obsługiwana. Obsługiwane wersje to "2016-12-12", "2018-11-01-preview". -
400 InvalidUrl Nie można przeanalizować adresu URL żądania "/a/b". -
400 Nieprawidłowe dane wejściowe Podane zapytanie "agregacja" jest nieprawidłowe. Obsługiwane zapytania to "getEvents",'getSeries','aggregateSeries'. InvalidQueryType
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych "$event.temperature.Double > 0" w polu "projectedVariables.temperature.value" nie jest prawidłowym wyrażeniem odwołania do właściwości. InvalidPropertyReferenceExpression
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych "$event.temperature.Double" w pliku "projectedVariables.temperature.filter" jest nieprawidłowe. Może to być tylko wyrażenie predykatu, które zwraca wartość logiczną. InvalidPredicateExpression
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych "$event.temperature.Double" w polu "projectedVariables.temperature.aggregation" jest nieprawidłowe. Nie zawierał on wyrażenia agregującego. InvalidAggregateExpression
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych "$event.temperature.Double > 0" w polu "projectedVariables.temperature.value" nie jest prawidłowym wyrażeniem wartości typu "numeric". InvalidValueExpression (Nieprawidłowe wyrażenie wartości)
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych wartości w polu "projectedVariables.temperature.value" nie powinno być określone lub powinno mieć wartość null dla zmiennej rodzaju "aggregate". ValueExpressionShouldNotBeSpecified
400 Nieprawidłowe dane wejściowe Wyrażenie szeregów czasowych wartości w polu "projectedVariables.temperature.value" powinno być określone dla rodzaju zmiennej "numeric". ValueExpressionShouldBeSpecified
400 Nieprawidłowe dane wejściowe Zmienna rodzaju "aggregate" jest nieprawidłowa dla wyrażenia "min($value)" w "projectedVariables.temperature.aggregation". InvalidVariableKind
400 Nieprawidłowe dane wejściowe Przedział czasu "00.00:01" w polu "interwał" nie jest prawidłowym formatem ISO8601 przedziału czasu. InvalidTimeSpanFormat
400 Nieprawidłowe dane wejściowe Nie można odnaleźć wystąpienia z identyfikatorem timeSeriesId "["ABC123"]". InstanceNotFound (WystąpienieNieznalezione)
400 Nieprawidłowe dane wejściowe Nie można odnaleźć wystąpienia o nazwie "timeSeriesName". InstanceNotFound (WystąpienieNieznalezione)
400 Nieprawidłowe dane wejściowe Nie można usunąć wystąpienia z identyfikatorem timeSeriesId "["ABC321"]". Istnieją już pozyskane zdarzenia skojarzone z tym identyfikatorem szeregów czasowych. CannotDeleteInstance
400 Nieprawidłowe dane wejściowe Środowisko o identyfikatorze "5e19f688-83fb-4aee-8321-5c123ed016b7" nie obsługuje interfejsów API zapytań szeregów czasowych. TimeSeriesQueryNotSupported
400 Nieprawidłowe dane wejściowe Zmienna rzutowana o nazwie "temperatura" nie została znaleziona w definicji typu lub zmiennej wbudowanej. ProjectedVariableNotFound (Projektowana zmienna nieznaleziona)
400 Nieprawidłowe dane wejściowe Nie można wpisać operacji upsert o identyfikatorze "7e19g688-83fb-4aee-8321-5c123ed016b7" i nazwie "ABC123". Ta nazwa jest już używana przez typ o identyfikatorze "6e19g688-83fb-4aee-8321-5c123ed016b7". NazwaJużIstnieje.
400 Nieprawidłowe dane wejściowe Nie można utworzyć hierarchii upsert o identyfikatorze "4e19g688-83fb-4aee-8321-7c123ed016b7" i nazwie "XYZ123". Ta nazwa jest już używana przez hierarchię o identyfikatorze "8e39g688-83fb-4aee-8321-5c123ed016b7". HierarchyNotDefined (Zdefiniowano hierarchię)
400 Nieprawidłowe dane wejściowe Liczba wystąpień przekroczyła limit "1 000 000". NumberOfInstancesExceededLimit
400 Nieprawidłowe dane wejściowe Liczba typów przekroczyła limit "1000". NumberOfTypesExceededLimit
400 Nieprawidłowe dane wejściowe Liczba hierarchii przekroczyła limit "32". NumberOfHierarchiesExceededLimit
400 Nieprawidłowe dane wejściowe Rozmiar jednostki jest większy niż maksymalny dozwolony rozmiar "16 384". ObjectSizeExceededLimit (Limit obiektu)
400 Nieprawidłowe dane wejściowe Nazwa obiektu "ABC123" o długości "6" przekracza maksymalny dozwolony limit znaków "5". NameExceededLimit
408 RequestTimeout Upłynął limit czasu żądania po upływie "30" sekund. BatchRequestSizeExceededLimit
503 Zbyt wiele żądań Przekroczono liczbę jednoczesnych żądań "30" dla środowiska "95880732-01b9-44ea-8d2d-4d764dfe1904". EnvRequestLimitExceeded (Przekroczył limit)

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.

  • Last updated on