2. generációs lekérdezési API-k Azure Time Series Insights
Áttekintés
A Query API-kat három REST API alkotja, amelyek mindegyike egy API-val szolgál eseményekhez, sorozatokhoz és összesítésekhez.
A Lekérdezés API-k egy adott időtartomány eseménysémáját és eseményszámait adják vissza a HTTP GET-kérelmeken keresztül, opcionális lapozással. Az adatsorok és az összesítő adatsorok információi a GET műveleteken keresztül is elérhetők opcionális lapozással.
API | Leírás |
---|---|
Események lekérése API | A keresési tartománynak és a predikátumnak megfelelő nyers események listáját adja vissza. |
Series API lekérése | Lehetővé teszi a Time Series Insights-adatok lekérdezését és lekérését a rögzített eseményekből a vezetéken rögzített adatok használatával a modellben meghatározott vagy beágyazott módon megadott változókon keresztül. |
Aggregátumsorozat API | Lehetővé teszi a Time Series Insights-adatok lekérdezését és lekérését a rögzített eseményekből a rögzített adatok összesítésével az összesítő vagy mintafüggvények használatával. |
Az API-k a HTTP-kérelem JSON-törzsén keresztül meghatározott különböző testreszabott műveleteket is támogatnak. A lekérdezésdefiníciók a gyakori műveletekhez használhatók.
Fontos
- A JSON-alapú simítási és menekülési szabályok közelgő módosításainak részeként a tömbök dinamikus típusként lesznek tárolva. Az ilyen típusú adattartalom-tulajdonságok csak az Események lekérése API-val érhetők el.
Hibaválaszok
Ha a lekérdezés végrehajtása sikertelen, a JSON-válasz hasznos adata az alábbi struktúrának megfelelő hibaválaszt fog tartalmazni:
{
"error" : {
"code" : "...",
"message" : "...",
"innerError" : {
"code" : "...",
"message" : "...",
}
}
}
innerError
Itt nem kötelező megadni. Az olyan alapvető hibák mellett, mint a helytelen formátumú kérések, a rendszer a következő hibákat adja vissza:
HTTP-állapotkód | Hibakód | Példa hibaüzenet | Lehetséges innerError-kódok |
---|---|---|---|
400 | InvalidApiVersion | A 2016-os API-verzió nem támogatott. A támogatott verziók a következők: "2016-12-12", "2018-11-01-preview". | - |
400 | InvalidUrl | A kérelem URL-címe (/a/b) nem elemezhető. | - |
400 | InvalidInput | A megadott "összesítés" lekérdezés érvénytelen. A támogatott lekérdezések a következők: "getEvents", "getSeries", "aggregateSeries". | InvalidQueryType |
400 | InvalidInput | A "projectedVariables.temperature.value" "$event.temperature.Double > 0" idősorkifejezése nem érvényes tulajdonsághivatkozási kifejezés. | InvalidPropertyReferenceExpression |
400 | InvalidInput | A "projectedVariables.temperature.filter" "$event.temperature.Double" idősorkifejezése érvénytelen. Csak olyan predikátumkifejezés lehet, amely logikai értéket ad vissza. | InvalidPredicateExpression |
400 | InvalidInput | A "projectedVariables.temperature.aggregation" "$event.temperature.Double" idősorkifejezése érvénytelen. Nem tartalmaz összesített kifejezést. | InvalidAggregateExpression |
400 | InvalidInput | A "projectedVariables.temperature.value" "$event.temperature.Double > 0" idősorkifejezése nem egy numerikus típusú érvényes értékkifejezés. | InvalidValueExpression |
400 | InvalidInput | A "projectedVariables.temperature.value" érték idősor-kifejezését nem szabad megadni, vagy null értékűnek kell lennie az "összesítés" típusú változó esetében. | ValueExpressionShouldNotBeSpecified |
400 | InvalidInput | A "projectedVariables.temperature.value" változótípusban meg kell adni az érték idősor-kifejezését. | ValueExpressionShouldBeSpecified |
400 | InvalidInput | Az "összesítés" változótípus érvénytelen a "min($value)" kifejezés esetében a "projectedVariables.temperature.aggregation" kifejezésben. | InvalidVariableKind |
400 | InvalidInput | A "interval" időtartományban lévő "00.00:01" időtartomány nem érvényes ISO8601 időtartomány-formátum. | InvalidTimeSpanFormat |
400 | InvalidInput | A(z) "["ABC123"] timeSeriesId azonosítójú példány nem található. | InstanceNotFound |
400 | InvalidInput | A "timeSeriesName" nevű példány nem található. | InstanceNotFound |
400 | InvalidInput | A(z) "["ABC321"] timeSeriesId azonosítójú példány nem törölhető. Ehhez az idősor-azonosítóhoz már vannak betöltve események. | Nem sikerült aDeleteInstance |
400 | InvalidInput | Az "5e19f688-83fb-4aee-8321-5c123ed016b7" azonosítójú környezet nem támogatja az idősoros lekérdezési API-kat. | TimeSeriesQueryNotSupported |
400 | InvalidInput | A "temperature" nevű előre jelzett változó nem található a típus- vagy beágyazott változódefiníciókban. | ProjectedVariableNotFound |
400 | InvalidInput | Nem sikerült a 7e19g688-83fb-4aee-8321-5c123ed016b7 azonosítójú és "ABC123" nevű típus beszúrása. Ezt a nevet már használja a 6e19g688-83fb-4aee-8321-5c123ed016b7 azonosítójú típus. | NameAlreadyExists |
400 | InvalidInput | Nem sikerült létrehozni a 4e19g688-83fb-4aee-8321-7c123ed016b7 azonosítójú és "XYZ123" nevű hierarchiát. Ezt a nevet már használja a 8e39g688-83fb-4aee-8321-5c123ed016b7 azonosítójú hierarchia. | HierarchyNotDefined |
400 | InvalidInput | A példányok száma túllépte az 1 000 000-es korlátot. | NumberOfInstancesExceededLimit |
400 | InvalidInput | A típusok száma túllépte az 1000-es korlátot. | NumberOfTypesExceededLimit |
400 | InvalidInput | A hierarchiák száma túllépte a 32-es korlátot. | NumberOfHierarchiesExceededLimit |
400 | InvalidInput | Az entitás mérete meghaladja a maximálisan megengedett 16 384-es méretet. | ObjectSizeExceededLimit |
400 | InvalidInput | A "6" hosszúságú "ABC123" objektumnév meghaladja az "5" karakter maximális megengedett korlátját. | NameExceededLimit |
408 | RequestTimeout | A kérés a 30 másodperc után időtúllépés miatt időtúllépést tapasztalt. | BatchRequestSizeExceededLimit |
503 | TooManyRequests | A "95880732-01b9-44ea-8d2d-4d764dfe1904" környezet esetében túllépte a 30-at. | EnvRequestLimitExceeded |
Lásd még
További információ az alkalmazásregisztrációról és az Azure Active Directory programozási modellről: Azure Active Directory fejlesztőknek.
A kérelem és a hitelesítési paraméterek megismeréséhez olvassa el a Hitelesítés és engedélyezés című témakört.
A HTTP-kérések és -válaszok tesztelését segítő eszközök a következők:
Fiddler. Ez az ingyenes webes hibakeresési proxy elfoghatja a REST-kéréseket, így diagnosztizálhatja a HTTP-kéréseket és a válaszüzeneteket.
JWT.io. Ezzel az eszközzel gyorsan kiadhatja a jogcímeket a tulajdonosi jogkivonatban, majd ellenőrizheti azok tartalmát.
Postman. Ez egy ingyenes HTTP-kérés- és választesztelési eszköz a REST API-k hibakereséséhez.
A Gen2 Azure Time Series Insights a Gen2 dokumentációjában talál további információt.