Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Übersicht
Die Abfrage-APIs bestehen aus drei REST-APIs, jeweils eine API für Ereignisse, Reihen und Aggregate.
Die Abfrage-APIs geben das Ereignisschema und die Ereignisanzahl über einen angegebenen Zeitraum über HTTP GET-Anforderungen mit optionaler Paginierung zurück. Reihen- und aggregierte Reiheninformationen werden auch über GET-Vorgänge mit optionaler Paginierung verfügbar gemacht.
| API | BESCHREIBUNG |
|---|---|
| Api zum Abrufen von Ereignissen | Gibt eine Liste von Rohereignissen zurück, die der Suchspanne und dem Prädikat entsprechen. |
| Abrufen der Serien-API | Ermöglicht das Abfragen und Abrufen von Time Series Insights-Daten aus erfassten Ereignissen mithilfe von Daten, die über die im Modell definierten oder inline bereitgestellten Variablen aufgezeichnet werden. |
| Aggregatreihen-API | Ermöglicht das Abfragen und Abrufen von Time Series Insights-Daten aus erfassten Ereignissen, indem aufgezeichnete Daten mithilfe der Aggregat- oder Beispielfunktionen aggregiert werden. |
Die APIs unterstützen auch eine Vielzahl von benutzerdefinierten Vorgängen , die über den JSON-Text der HTTP-Anforderung angegeben werden. Abfragedefinitionen können für allgemeine Vorgänge verwendet werden.
Wichtig
- Im Rahmen der bevorstehenden Änderungen für JSON-Vereinfachungs- und -Escaperegeln werden Arrays mit dem Typ Dynamic gespeichert. Nutzlasteigenschaften, die mit diesem Typ gespeichert werden, sind NUR über die Ereignisabruf-API zugänglich.
Fehlercodes
Wenn die Abfrageausführung fehlschlägt, enthält die JSON-Antwortnutzlast eine Fehlerantwort, die der folgenden Struktur entspricht:
{
"error" : {
"code" : "...",
"message" : "...",
"innerError" : {
"code" : "...",
"message" : "...",
}
}
}
innerError Hier ist optional. Zusätzlich zu grundlegenden Fehlern wie einer falsch formatierten Anforderung werden die folgenden Fehler zurückgegeben:
| HTTP-status-Code | Fehlercode | Beispielfehlermeldung | Mögliche innerError-Codes |
|---|---|---|---|
| 400 | InvalidApiVersion | Die API-Version "2016" wird nicht unterstützt. Unterstützte Versionen sind "2016-12-12", "2018-11-01-preview". | - |
| 400 | InvalidUrl | Die Anforderungs-URL "/a/b" konnte nicht analysiert werden. | - |
| 400 | InvalidInput | Das angegebene Abfrageaggregat ist ungültig. Unterstützte Abfragen sind "getEvents", "getSeries", "aggregateSeries". | InvalidQueryType |
| 400 | InvalidInput | Der Zeitreihenausdruck "$event.temperature.Double > 0" in "projectedVariables.temperature.value" ist kein gültiger Eigenschaftenverweisausdruck. | InvalidPropertyReferenceExpression |
| 400 | InvalidInput | Der Zeitreihenausdruck "$event.temperature.Double" in "projectedVariables.temperature.filter" ist ungültig. Es kann nur ein Prädikatausdruck sein, der einen booleschen Wert zurückgibt. | InvalidPredicateExpression |
| 400 | InvalidInput | Der Zeitreihenausdruck "$event.temperature.Double" in "projectedVariables.temperature.aggregation" ist ungültig. Es enthielt keinen Aggregatausdruck. | InvalidAggregateExpression |
| 400 | InvalidInput | Der Zeitreihenausdruck "$event.temperature.Double > 0" in "projectedVariables.temperature.value" ist kein gültiger Wertausdruck vom Typ "numeric". | InvalidValueExpression |
| 400 | InvalidInput | Der Wertzeitreihenausdruck in "projectedVariables.temperature.value" darf nicht angegeben werden oder sollte null für die Variable des Typs "aggregate" sein. | ValueExpressionShouldNotBeSpecified |
| 400 | InvalidInput | Der Wertzeitreihenausdruck in "projectedVariables.temperature.value" sollte für den Variablentyp "numeric" angegeben werden. | ValueExpressionShouldBeSpecified |
| 400 | InvalidInput | Der Variablentyp "aggregate" ist für den Ausdruck "min($value)" in "projectedVariables.temperature.aggregation" ungültig. | InvalidVariableKind |
| 400 | InvalidInput | Der Zeitraum "00.00:01" in "interval" ist kein gültiges ISO8601-Zeitbereichsformat. | InvalidTimeSpanFormat |
| 400 | InvalidInput | Die instance mit timeSeriesId '["ABC123"]' wurde nicht gefunden. | InstanceNotFound |
| 400 | InvalidInput | Die instance mit dem Namen "timeSeriesName" wurde nicht gefunden. | InstanceNotFound |
| 400 | InvalidInput | Die instance mit timeSeriesId '["ABC321"]' kann nicht gelöscht werden. Dieser Zeitreihen-ID sind bereits erfasste Ereignisse zugeordnet. | CannotDeleteInstance |
| 400 | InvalidInput | Die Umgebung mit der ID "5e19f688-83fb-4aee-8321-5c123ed016b7" unterstützt keine Zeitreihenabfrage-APIs. | TimeSeriesQueryNotSupported |
| 400 | InvalidInput | Die projizierte Variable mit dem Namen "temperature" wurde in den Typ- oder Inlinevariablendefinitionen nicht gefunden. | ProjectedVariableNotFound |
| 400 | InvalidInput | Der Typ mit der ID "7e19g688-83fb-4aee-8321-5c123ed016b7" und dem Namen "ABC123" kann nicht upsert werden. Dieser Name wird bereits vom Typ mit der ID "6e19g688-83fb-4aee-8321-5c123ed016b7" verwendet. | NameAlreadyExists |
| 400 | InvalidInput | Die Hierarchie kann mit der ID "4e19g688-83fb-4aee-8321-7c123ed016b7" und dem Namen "XYZ123" nicht upsert werden. Dieser Name wird bereits von der Hierarchie mit der ID "8e39g688-83fb-4aee-8321-5c123ed016b7" verwendet. | HierarchyNotDefined |
| 400 | InvalidInput | Die Anzahl der Instanzen hat den Grenzwert von "1.000.000" überschritten. | NumberOfInstancesExceededLimit |
| 400 | InvalidInput | Die Anzahl der Typen hat den Grenzwert von "1000" überschritten. | NumberOfTypesExceededLimit |
| 400 | InvalidInput | Die Anzahl der Hierarchien hat den Grenzwert von "32" überschritten. | NumberOfHierarchiesExceededLimit |
| 400 | InvalidInput | Die Entitätsgröße ist größer als die maximal zulässige Größe "16.384". | ObjectSizeExceededLimit |
| 400 | InvalidInput | Der Objektname "ABC123" mit der Länge "6" überschreitet den maximal zulässigen Zeichengrenzwert von "5". | NameExceededLimit |
| 408 | RequestTimeout | Zeitüberschreitung der Anforderung nach "30" Sekunden. | BatchRequestSizeExceededLimit |
| 503 | TooManyRequests | Die Gleichzeitige Anforderungsanzahl von "30" wurde für die Umgebung "95880732-01b9-44ea-8d2d-4d764dfe1904" überschritten. | EnvRequestLimitExceededed |
Weitere Informationen
Weitere Informationen zur Anwendungsregistrierung und zum Azure Active Directory-Programmiermodell finden Sie unter Azure Active Directory für Entwickler.
Informationen zu Anforderungs- und Authentifizierungsparametern finden Sie unter Authentifizierung und Autorisierung.
Zu den Tools, die beim Testen von HTTP-Anforderungen und -Antworten helfen, gehören:
Fiddler. Dieser kostenlose Webdebugproxy kann Ihre REST-Anforderungen abfangen, sodass Sie die HTTP-Anforderung und -Antwortnachrichten diagnostizieren können.
JWT.io. Sie können dieses Tool verwenden, um die Ansprüche in Ihrem Bearertoken schnell abzuspeichern und dann deren Inhalt zu überprüfen.
Postman. Dies ist ein kostenloses HTTP-Anforderungs- und Antworttesttool zum Debuggen von REST-APIs.
Weitere Informationen zu Azure Time Series Insights Gen2 finden Sie in der Gen2-Dokumentation.