Delen via


Azure Time Series Insights Gen2 Query-API's

Overzicht

De query-API's worden gevormd door drie REST-API's, elk één API voor gebeurtenissen, reeksen en aggregaties.

De query-API's retourneren het gebeurtenisschema en het aantal gebeurtenissen over een opgegeven tijdsbereik via HTTP GET-verzoeken met optionele paginering. Reeks - en geaggregeerde reeksinformatie wordt ook weergegeven via GET-bewerkingen met optionele paginering.

API (Application Programming Interface) Beschrijving
Evenementen-API ophalen Retourneert een lijst met onbewerkte gebeurtenissen die overeenkomen met het zoekbereik en het predicaat.
Serie-API ophalen Maakt het mogelijk om Time Series Insights-gegevens van vastgelegde gebeurtenissen op te vragen en op te halen met behulp van gegevens die op de draad zijn vastgelegd via de variabelen die in het model zijn gedefinieerd of inline zijn opgegeven.
API voor geaggregeerde reeksen Maakt het mogelijk om Time Series Insights-gegevens van vastgelegde gebeurtenissen op te vragen en op te halen door geregistreerde gegevens samen te voegen met behulp van de aggregatie- of voorbeeldfuncties.

De API's ondersteunen ook een verscheidenheid aan aangepaste bewerkingen die zijn gespecificeerd via de JSON-body voor HTTP-aanvragen. Querydefinities kunnen worden gebruikt voor algemene bewerkingen.

Belangrijk

Foutreacties

Als de uitvoering van de query mislukt, bevat de nettolading van het JSON-antwoord een foutantwoord dat voldoet aan de volgende structuur:

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

Hier, innerError is optioneel. Naast basisfouten zoals een verkeerd ingedeeld verzoek, worden de volgende fouten geretourneerd:

Http-statuscode Foutcode Voorbeeld foutmelding Mogelijke innerFoutcodes
400 InvalidApiVersion API-versie '2016' wordt niet ondersteund. Ondersteunde versies zijn '2016-12-12', '2018-11-01-preview'. -
400 InvalidUrl De verzoek-URL '/a/b' kan niet worden geparseerd. -
400 OngeldigeInvoer De opgegeven query 'aggregatie' is niet geldig. Ondersteunde query's zijn 'getEvents','getSeries','aggregateSeries'. InvalidQueryType
400 OngeldigeInvoer De tijdreeksexpressie '$event.temperature.Double > 0' in 'projectedVariables.temperature.value' is geen geldige eigenschap referentie-expressie. InvalidPropertyReferenceExpression
400 OngeldigeInvoer De tijdreeksexpressie '$event.temperature.Double' in 'projectedVariables.temperature.filter' is ongeldig. Het kan alleen een predikaatuitdrukking zijn die een booleaanse teruggeeft. InvalidPredicateExpression
400 OngeldigeInvoer De tijdreeksexpressie '$event.temperature.Double' in 'projectedVariables.temperature.aggregation' is ongeldig. Het bevatte geen geaggregeerde expressie. InvalidAggregateExpression
400 OngeldigeInvoer De tijdreeksexpressie '$event.temperature.Double > 0' in 'projectedVariables.temperature.value' is geen geldige waarde-expressie van het type 'numeric'. InvalidValueExpression
400 OngeldigeInvoer De waarde tijdreeksexpressie in 'projectedVariables.temperature.value' mag niet worden opgegeven of moet null zijn voor de variabele van het type 'aggregaat'. ValueExpressionShouldNotBeSpecified
400 OngeldigeInvoer De waarde tijdreeksexpressie in 'projectedVariables.temperature.value' moet worden gespecificeerd voor de variabele soort 'numeriek'. ValueExpressionShouldBeSpecified
400 OngeldigeInvoer De variabele type 'aggregate' is ongeldig voor de expressie 'min($value)' in 'projectedVariables.temperature.aggregation'. InvalidVariableKind
400 OngeldigeInvoer De tijdspanne '00.00:01' in 'interval' is geen geldig ISO8601 tijdspanne. InvalidTimeSpanFormat
400 OngeldigeInvoer Het exemplaar met timeSeriesId '["ABC123"]' wordt niet gevonden. InstantieNietGevonden
400 OngeldigeInvoer Het exemplaar met de naam 'timeSeriesName' wordt niet gevonden. InstantieNietGevonden
400 OngeldigeInvoer De instantie met timeSeriesId '["ABC321"]' kan niet worden verwijderd. Er zijn al opgenomen gebeurtenissen gekoppeld aan deze tijdreeks-id. Kan nietDeleteInstance
400 OngeldigeInvoer De omgeving met ID '5e19f688-83fb-4aee-8321-5c123ed016b7' biedt geen ondersteuning voor tijdreeksquery-API's. TimeSeriesQueryNotSupported
400 OngeldigeInvoer De geprojecteerde variabele met de naam 'temperatuur' werd niet gevonden in de definities van type of inline variabele. ProjectedVariableNotFound
400 OngeldigeInvoer Kan typen met ID '7e19g688-83fb-4aee-8321-5c123ed016b7' en naam 'ABC123' niet upgraden. Deze naam wordt al gebruikt door type met ID '6e19g688-83fb-4aee-8321-5c123ed016b7'. NaamBestaat al
400 OngeldigeInvoer Kan hiërarchie niet upgraden met ID '4e19g688-83fb-4aee-8321-7c123ed016b7' en naam 'XYZ123'. Deze naam wordt al gebruikt door de hiërarchie met ID '8e39g688-83fb-4aee-8321-5c123ed016b7'. HiërarchieNietGedefinieerd
400 OngeldigeInvoer Het aantal gevallen overschreed de limiet van '1.000.000'. NumberOfInstancesExceededLimit
400 OngeldigeInvoer Het aantal typen overschreed de grens van '1000'. Aantal typenOverschredenlimiet
400 OngeldigeInvoer Het aantal hiërarchieën overschreed de grens van '32'. AantalHiërarchieënOverschredenLimiet
400 OngeldigeInvoer De entiteitsgrootte is groter dan de maximaal toegestane grootte '16.384'. ObjectGrootteExceededLimit
400 OngeldigeInvoer De objectnaam 'ABC123' met lengte '6' overschrijdt de maximaal toegestane tekenlimiet van '5'. NaamOverschredenLimiet
408 RequestTimeout Time-out van het verzoek na '30' seconde(n). BatchRequestSizeExceededLimit
503 TeVeelVerzoeken Het aantal gelijktijdige verzoeken van '30' is overschreden voor de omgeving '95880732-01b9-44ea-8d2d-4d764dfe1904'. EnvRequestLimitExceeded

Zie ook

  • Zie Azure Active Directory voor ontwikkelaars voor meer informatie over toepassingsregistratie en het Azure Active Directory-programmeermodel.

  • Lees Verificatie en autorisatie voor meer informatie over aanvraag- en verificatieparameters.

  • Tools die helpen bij het testen van HTTP-verzoeken en -antwoorden zijn onder andere:

  • Vioolspeler. Deze gratis proxy voor webfoutopsporing kan uw REST-verzoeken onderscheppen, zodat u de HTTP-verzoeken en antwoordberichten kunt diagnosticeren.

  • JWT.io. U kunt deze tool gebruiken om de claims snel in uw bearer token te dumpen en vervolgens de inhoud ervan te valideren.

  • Postbode. Dit is een gratis tool voor het testen van HTTP-verzoeken en -antwoorden voor het debuggen van REST API's.

  • Meer informatie over Azure Time Series Insights Gen2 vindt u in de Gen2-documentatie.