rozhraní API pro dotazy Azure Time Series Insights Gen2
Přehled
Rozhraní API pro dotazy se skládají ze tří rozhraní REST API, z nichž každé je jedno rozhraní API pro události, řady a agregace.
Rozhraní API pro dotazy vrací schéma událostí a počty událostí v zadaném časovém rozsahu prostřednictvím požadavků HTTP GET s volitelným stránkováním. Informace o řadách a agregovaných řadách se také zveřejňují prostřednictvím operací GET s volitelným stránkováním.
Rozhraní API | Popis |
---|---|
Rozhraní API pro získání událostí | Vrátí seznam nezpracovaných událostí, které odpovídají rozsahu hledání a predikátu. |
Získat rozhraní API řady | Umožňuje dotazovat a načítat data Time Series Insights ze zachycených událostí pomocí dat zaznamenaných na drátě prostřednictvím proměnných definovaných v modelu nebo zadaných vložených. |
Rozhraní API agregovaných řad | Umožňuje dotazování a načítání dat Time Series Insights ze zachycených událostí agregací zaznamenaných dat pomocí agregačních nebo ukázkových funkcí. |
Rozhraní API také podporují řadu přizpůsobených operací zadaných prostřednictvím textu JSON požadavku HTTP. Definice dotazů se dají použít pro běžné operace.
Důležité
- V rámci nadcházejících změn pravidel zploštělování a úniku kódu JSON se pole uloží jako dynamický typ. Vlastnosti datové části uložené jako tento typ jsou přístupné POUZE prostřednictvím rozhraní API Pro získání událostí.
Chybové odpovědi
Pokud se provádění dotazu nezdaří, datová část odpovědi JSON bude obsahovat chybovou odpověď, která odpovídá následující struktuře:
{
"error" : {
"code" : "...",
"message" : "...",
"innerError" : {
"code" : "...",
"message" : "...",
}
}
}
innerError
Tady je nepovinný argument. Kromě základních chyb, jako je chybný požadavek, se vrátí následující chyby:
Stavový kód HTTP | Kód chyby | Příklad chybové zprávy | Možné kódy vnitřních chyb |
---|---|---|---|
400 | InvalidApiVersion | Verze rozhraní API 2016 se nepodporuje. Podporované verze jsou '2016-12-12', '2018-11-01-preview'. | - |
400 | Neplatná adresa | Adresu URL požadavku /a/b nelze analyzovat. | - |
400 | InvalidInput | Zadaný dotaz agregace není platný. Podporované dotazy jsou getEvents, getSeries a aggregateSeries. | InvalidQueryType |
400 | InvalidInput | Výraz časové řady "$event.temperature.Double > 0" v projectedVariables.temperature.value není platným výrazem odkazu na vlastnost. | InvalidPropertyReferenceExpression |
400 | InvalidInput | Výraz časové řady '$event.temperature.Double' v 'projectedVariables.temperature.filter' je neplatný. Může to být pouze predikátový výraz, který vrací logickou hodnotu. | InvalidPredicateExpression |
400 | InvalidInput | Výraz časové řady '$event.temperature.Double' v 'projectedVariables.temperature.aggregation' je neplatný. Neobsahoval agregační výraz. | InvalidAggregateExpression |
400 | InvalidInput | Výraz časové řady '$event.temperature.Double > 0' v 'projectedVariables.temperature.value' není platným výrazem hodnoty typu 'numeric'. | InvalidValueExpression |
400 | InvalidInput | Výraz časové řady hodnot v projectedVariables.temperature.value by neměl být zadán nebo by měl mít hodnotu null pro proměnnou typu aggregate. | ValueExpressionShouldNotBeSpecified |
400 | InvalidInput | Výraz časové řady hodnoty v projectedVariables.temperature.value by měl být zadán pro proměnnou typu numeric. | ValueExpressionShouldBeSpecified |
400 | InvalidInput | Druh proměnné aggregate je neplatný pro výraz min($value) v projectedVariables.temperature.aggregation. | InvalidVariableKind |
400 | InvalidInput | Časový rozsah 00.00:01 v intervalu není platným formátem časového rozsahu ISO8601. | InvalidTimeSpanFormat |
400 | InvalidInput | Instance s timeSeriesId ["ABC123"]" nebyla nalezena. | InstanceNotFound |
400 | InvalidInput | Instance s názvem timeSeriesName nebyla nalezena. | InstanceNotFound |
400 | InvalidInput | Instanci s timeSeriesId ["ABC321"]" nelze odstranit. K tomuto ID časové řady jsou již přidruženy ingestované události. | CannotDeleteInstance |
400 | InvalidInput | Prostředí s ID 5e19f688-83fb-4aee-8321-5c123ed016b7 nepodporuje rozhraní API pro dotazy časových řad. | TimeSeriesQueryNotSupported |
400 | InvalidInput | V definicích typu nebo vložené proměnné nebyla nalezena projektovaná proměnná s názvem temperature. | ProjectedVariableNotFound |
400 | InvalidInput | Nelze přenést typ s ID 7e19g688-83fb-4aee-8321-5c123ed016b7 a názvem ABC123. Tento název se už používá podle typu s ID 6e19g688-83fb-4aee-8321-5c123ed016b7. | NameAlreadyExists |
400 | InvalidInput | Nejde převést hierarchii s ID 4e19g688-83fb-4aee-8321-7c123ed016b7 a názvem XYZ123. Tento název už používá hierarchie s ID 8e39g688-83fb-4aee-8321-5c123ed016b7. | HierarchyNotDefined |
400 | InvalidInput | Počet instancí překročil limit 1 000 000. | NumberOfInstancesExceedLimit |
400 | InvalidInput | Počet typů překročil limit 1000. | NumberOfTypesExceededLimit |
400 | InvalidInput | Počet hierarchií překročil limit 32. | NumberOfHierarchiesExceededLimit |
400 | InvalidInput | Velikost entity je větší než maximální povolená velikost 16 384. | ObjectSizeExceededLimit |
400 | InvalidInput | Název objektu "ABC123" o délce 6 překračuje maximální povolený limit znaků "5". | NameExceededLimit |
408 | RequestTimeout | Časový limit požadavku vypršel po 30 sekundách. | BatchRequestSizeExceededLimit |
503 | TooManyRequests | Počet souběžných požadavků 30 byl překročen pro prostředí 95880732-01b9-44ea-8d2d-4d764dfe1904. | EnvRequestLimitExceeded |
Viz také
Další informace o registraci aplikací a programovacím modelu Azure Active Directory najdete v tématu Azure Active Directory pro vývojáře.
Další informace o parametrech požadavků a ověřování najdete v tématu Ověřování a autorizace.
Mezi nástroje, které pomáhají s testováním požadavků a odpovědí HTTP, patří:
Fiddleři. Tento bezplatný webový ladicí proxy server může zachycovat vaše požadavky REST, abyste mohli diagnostikovat požadavky HTTP a zprávy odpovědí.
JWT.io. Tento nástroj můžete použít k rychlému výpisu deklarací identity v nosným tokenu a následnému ověření jejich obsahu.
Postman. Toto je bezplatný nástroj pro testování požadavků HTTP a odpovědí pro ladění rozhraní REST API.
Další informace o Azure Time Series Insights Gen2 najdete v dokumentaci k Gen2.