Delen via

Azure Time Series Insights Gen2-query-API's

  • Artikel

Overzicht

De query-API's bestaan uit drie REST API's, elk één API voor gebeurtenissen, reeksen en aggregaties.

De query-API's retourneren het gebeurtenisschema en het aantal gebeurtenissen gedurende een opgegeven tijdsbereik via HTTP GET-aanvragen met optionele paginering. Gegevens over reeksen en aggregaties worden ook weergegeven via GET-bewerkingen met optionele paginering.

API Beschrijving
Gebeurtenissen-API ophalen Retourneert een lijst met onbewerkte gebeurtenissen die overeenkomen met het zoekbereik en het predicaat.
Reeks-API ophalen Hiermee kunt u query's uitvoeren op en ophalen van Time Series Insights-gegevens uit vastgelegde gebeurtenissen door gebruik te maken van gegevens die zijn vastgelegd op de kabel via de variabelen die in het model zijn gedefinieerd of inline zijn opgegeven.
Statistische reeks-API Hiermee kunt u query's uitvoeren op en ophalen van Time Series Insights-gegevens uit vastgelegde gebeurtenissen door opgenomen gegevens te aggregeren met behulp van de statistische of voorbeeldfuncties.

De API's ondersteunen ook verschillende aangepaste bewerkingen die zijn opgegeven via de JSON-hoofdtekst van de HTTP-aanvraag. Querydefinities kunnen worden gebruikt voor algemene bewerkingen.

Belangrijk

Foutreactiess

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" : "...",
        }
    }
}

innerError Hier is optioneel. Naast basisfouten zoals een onjuiste aanvraag, worden de volgende fouten geretourneerd:

HTTP-statuscode Foutcode Voorbeeld van foutbericht Mogelijke innerError-codes
400 InvalidApiVersion API-versie 2016 wordt niet ondersteund. Ondersteunde versies zijn '2016-12-12', '2018-11-01-preview'. -
400 InvalidUrl De aanvraag-URL '/a/b' kan niet worden geparseerd. -
400 InvalidInput De opgegeven query 'aggregaat' is ongeldig. Ondersteunde query's zijn 'getEvents','getSeries','aggregateSeries'. InvalidQueryType
400 InvalidInput De tijdreeksexpressie '$event.temperature.Double > 0' in 'projectedVariables.temperature.value' is geen geldige eigenschapsverwijzingsexpressie. InvalidPropertyReferenceExpression
400 InvalidInput De tijdreeksexpressie '$event.temperature.Double' in 'projectedVariables.temperature.filter' is ongeldig. Het kan alleen een predicaatexpressie zijn die een booleaanse waarde retourneert. InvalidPredicateExpression
400 InvalidInput De tijdreeksexpressie '$event.temperature.Double' in 'projectedVariables.temperature.aggregation' is ongeldig. Deze bevat geen aggregatie-expressie. InvalidAggregateExpression
400 InvalidInput De tijdreeksexpressie '$event.temperature.Double > 0' in 'projectedVariables.temperature.value' is geen geldige waarde-expressie van het type 'numeriek'. InvalidValueExpression
400 InvalidInput De waarde tijdreeksexpressie in 'projectedVariables.temperature.value' moet niet worden opgegeven of moet null zijn voor een variabele van het type 'aggregate'. ValueExpressionShouldNotBeSpecified
400 InvalidInput De waarde tijdreeksexpressie in 'projectedVariables.temperature.value' moet worden opgegeven voor het type variabele 'numeriek'. ValueExpressionShouldBeSpecified
400 InvalidInput Het type variabele 'aggregate' is ongeldig voor de expressie 'min($value)' in 'projectedVariables.temperature.aggregation'. InvalidVariableKind
400 InvalidInput De periode '00,00:01' in 'interval' is geen geldige ISO8601-indeling. InvalidTimeSpanFormat
400 InvalidInput Het exemplaar met timeSeriesId ["ABC123"] is niet gevonden. InstanceNotFound
400 InvalidInput Het exemplaar met de naam 'timeSeriesName' is niet gevonden. InstanceNotFound
400 InvalidInput Het exemplaar met timeSeriesId ["ABC321"] kan niet worden verwijderd. Er zijn al opgenomen gebeurtenissen gekoppeld aan deze tijdreeks-id. CannotDeleteInstance
400 InvalidInput De omgeving met id '5e19f688-83fb-4aee-8321-5c123ed016b7' biedt geen ondersteuning voor tijdreeksquery-API's. TimeSeriesQueryNotSupported
400 InvalidInput De geprojecteerde variabele met de naam 'temperatuur' is niet gevonden in de type- of inlinevariabeledefinities. ProjectedVariableNotFound
400 InvalidInput Kan geen upserttype uitvoeren met id '7e19g688-83fb-4aee-8321-5c123ed016b7' en de naam 'ABC123'. Deze naam wordt al gebruikt door het type met id '6e19g688-83fb-4aee-8321-5c123ed016b7'. NameAlreadyExists
400 InvalidInput Kan de hiërarchie niet upserteren met id '4e19g688-83fb-4aee-8321-7c123ed016b7' en de naam 'XYZ123'. Deze naam wordt al gebruikt door de hiërarchie met id '8e39g688-83fb-4aee-8321-5c123ed016b7'. HierarchyNotDefined
400 InvalidInput Het aantal exemplaren heeft de limiet van '1.000.000' overschreden. NumberOfInstancesExceededLimit
400 InvalidInput Het aantal typen heeft de limiet van 1000 overschreden. NumberOfTypesExceededLimit
400 InvalidInput Het aantal hiërarchieën heeft de limiet van '32' overschreden. NumberOfHierarchiesExceededLimit
400 InvalidInput De entiteitsgrootte is groter dan de maximaal toegestane grootte '16.384'. ObjectSizeExceededLimit
400 InvalidInput De objectnaam 'ABC123' met de lengte '6' overschrijdt de maximaal toegestane tekenlimiet van '5'. NameExceededLimit
408 RequestTimeout Er is een time-out opgetreden voor de aanvraag na '30' seconden. BatchRequestSizeExceededLimit
503 TooManyRequests Het aantal gelijktijdige aanvragen van '30' is overschreden voor 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.

  • Hulpprogramma's die helpen bij het testen van HTTP-aanvragen en -antwoorden zijn onder andere:

  • Fiddler. Met deze gratis webopsporingsproxy kunt u uw REST-aanvragen onderscheppen, zodat u de HTTP-aanvraag- en antwoordberichten kunt diagnosticeren.

  • JWT.io. U kunt dit hulpprogramma gebruiken om snel de claims in uw Bearer-token te dumpen en vervolgens de inhoud ervan te valideren.

  • Postman. Dit is een gratis hulpprogramma voor het testen van HTTP-aanvragen en -antwoorden voor het opsporen van fouten in REST API's.

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