Dela via

Azure Time Series Insights Fråge-API:er för Gen2

  • Artikel

Översikt

Fråge-API:erna består av tre REST-API:er, ett API vardera för händelser, serier och aggregeringar.

Fråge-API:erna returnerar händelseschema och händelseantal över ett angivet tidsintervall via HTTP GET-begäranden med valfri sidnumrering. Information om serier och aggregeringsserier exponeras också via GET-åtgärder med valfri sidnumrering.

API Beskrivning
API för att hämta händelser Returnerar en lista med råhändelser som matchar sökintervallet och predikatet.
Hämta serie-API Aktiverar frågor och hämtning av Time Series Insights-data från insamlade händelser med hjälp av data som registrerats på kabeln via variablerna som definierats i modellen eller angetts infogade.
API för aggregeringsserie Möjliggör fråge- och hämtning av Time Series Insights-data från insamlade händelser genom att aggregera registrerade data med hjälp av mängd- eller exempelfunktionerna.

API:erna stöder också en mängd olika anpassade åtgärder som anges via HTTP-begärande-JSON-brödtexten. Frågedefinitioner kan användas för vanliga åtgärder.

Viktigt

Felsvar

Om frågekörningen misslyckas innehåller JSON-svarsnyttolasten ett felsvar som överensstämmer med följande struktur:

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

innerError Här är valfritt. Förutom grundläggande fel som felaktig begäran returneras följande fel:

Http-statuskod Felkod Exempel på felmeddelande Möjliga innerError-koder
400 InvalidApiVersion API-versionen 2016 stöds inte. Versioner som stöds är "2016-12-12", "2018-11-01-preview". -
400 InvalidUrl Det gick inte att parsa begärande-URL:en "/a/b". -
400 InvalidInput Den angivna frågan "aggregate" är inte giltig. Frågor som stöds är "getEvents", "getSeries", "aggregateSeries". InvalidQueryType
400 InvalidInput Tidsserieuttrycket "$event.temperature.Double > 0" i "projectedVariables.temperature.value" är inte ett giltigt egenskapsreferensuttryck. InvalidPropertyReferenceExpression
400 InvalidInput Tidsserieuttrycket "$event.temperature.Double" i "projectedVariables.temperature.filter" är ogiltigt. Det kan bara vara ett predikatuttryck som returnerar ett booleskt värde. InvalidPredicateExpression
400 InvalidInput Tidsserieuttrycket "$event.temperature.Double" i "projectedVariables.temperature.aggregation" är ogiltigt. Det innehöll inget aggregeringsuttryck. InvalidAggregateExpression
400 InvalidInput Tidsserieuttrycket "$event.temperature.Double > 0" i "projectedVariables.temperature.value" är inte ett giltigt värdeuttryck av typen "numeriskt". InvalidValueExpression
400 InvalidInput Värdets tidsserieuttryck i "projectedVariables.temperature.value" ska inte anges eller vara null för variabeln av typen "aggregate". ValueExpressionShouldNotBeSpecified
400 InvalidInput Värdets tidsserieuttryck i "projectedVariables.temperature.value" ska anges för variabeltypen "numerisk". ValueExpressionShouldBeSpecified
400 InvalidInput Variabeltypen aggregering är ogiltig för uttrycket "min($value)" i "projectedVariables.temperature.aggregation". InvalidVariableKind
400 InvalidInput Tidsintervallet 00.00:01 i intervall är inte ett giltigt ISO8601-tidsintervallformat. InvalidTimeSpanFormat
400 InvalidInput Instansen med timeSeriesId ["ABC123"]" hittades inte. InstanceNotFound
400 InvalidInput Instansen med namnet "timeSeriesName" hittades inte. InstanceNotFound
400 InvalidInput Det går inte att ta bort instansen med timeSeriesId ["ABC321"]". Det finns redan inmatade händelser som är associerade med det här tidsserie-ID:t. CannotDeleteInstance
400 InvalidInput Miljön med ID:t "5e19f688-83fb-4aee-8321-5c123ed016b7" stöder inte API:er för tidsseriefrågor. TimeSeriesQueryNotSupported
400 InvalidInput Den planerade variabeln med namnet "temperature" hittades inte i definitionerna för typ- eller infogade variabler. ProjectedVariableNotFound
400 InvalidInput Det går inte att upsert-typen med ID 7e19g688-83fb-4aee-8321-5c123ed016b7 och namnet ABC123. Det här namnet används redan efter typ med ID 6e19g688-83fb-4aee-8321-5c123ed016b7. NameAlreadyExists
400 InvalidInput Det går inte att öka hierarkin med ID :t "4e19g688-83fb-4aee-8321-7c123ed016b7" och namnet "XYZ123". Det här namnet används redan av hierarkin med ID:t "8e39g688-83fb-4aee-8321-5c123ed016b7". HierarchyNotDefined
400 InvalidInput Antalet instanser överskred gränsen på "1 000 000". NumberOfInstancesExceededLimit
400 InvalidInput Antalet typer överskred gränsen på "1 000". NumberOfTypesExceededLimit
400 InvalidInput Antalet hierarkier överskred gränsen på 32. NumberOfHierarchiesExceededLimit
400 InvalidInput Entitetsstorleken är större än den maximala tillåtna storleken "16 384". ObjectSizeExceededLimit
400 InvalidInput Objektnamnet "ABC123" med längden "6" överskrider den maximala tillåtna teckengränsen på "5". NameExceededLimit
408 RequestTimeout Tidsgränsen för begäran översågs efter 30 sekunder. BatchRequestSizeExceededLimit
503 TooManyRequests Antalet samtidiga begäranden på "30" överskreds för miljön "95880732-01b9-44ea-8d2d-4d764dfe1904". EnvRequestLimitExceededed

Se även

  • Mer information om programregistrering och Azure Active Directory-programmeringsmodellen finns i Azure Active Directory för utvecklare.

  • Mer information om parametrar för begäran och autentisering finns i Autentisering och auktorisering.

  • Verktyg som hjälper dig att testa HTTP-begäranden och svar är:

  • Fiddler. Den här kostnadsfria webbfelsökningsproxyn kan fånga upp dina REST-begäranden så att du kan diagnostisera HTTP-begäran och svarsmeddelanden.

  • JWT.io. Du kan använda det här verktyget för att snabbt dumpa anspråken i ägartoken och sedan verifiera innehållet.

  • Postman. Det här är ett kostnadsfritt testverktyg för HTTP-begäran och svar för felsökning av REST-API:er.

  • Läs mer om Azure Time Series Insights Gen2 genom att läsa Gen2-dokumentationen.