Query - Get Event Schema

Referenz

Dienst:: Time Series Insights

API-Version:: 2020-07-31

Gibt das Umgebungsereignisschema für eine bestimmte Suchspanne zurück. Ereignisschema ist ein Satz von Eigenschaftendefinitionen. Das Ereignisschema enthält möglicherweise nicht alle persistenten Eigenschaften, wenn zu viele Eigenschaften vorhanden sind.

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

Mit optionalen Parametern:

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentFqdn	path	True	string	FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder Azure Resource Manager abrufen.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit wird die Version "2020-07-31" unterstützt.
storeType	query		string	Für Umgebungen mit aktiviertem Warmspeicher kann die Abfrage entweder im "WarmStore" oder "ColdStore" ausgeführt werden. Dieser Parameter in der Abfrage definiert, in welchem Speicher die Abfrage ausgeführt werden soll. Wenn nicht definiert, wird die Abfrage im kalten Speicher ausgeführt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string	Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id		string	Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst das Nachverfolgen einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
searchSpan	True	DateTimeRange	Der Zeitbereich, in dem die Abfrage ausgeführt wird. Darf nicht NULL sein.

Antworten

Name	Typ	Beschreibung
200 OK	EventSchema	Erfolgreiche Ausführung Header x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Header x-ms-request-id: string

Name

Typ

Beschreibung

200 OK

EventSchema

Erfolgreiche Ausführung

Header

x-ms-request-id: string

Other Status Codes

TsiError

Unerwarteter Fehler.

Header

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Beispielanforderung

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGet

Beispielanforderung

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGetEmpty

Beispielanforderung

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31

{
  "searchSpan": {
    "from": "2016-08-01T00:00:00.000Z",
    "to": "2016-08-31T00:00:00.000Z"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Beispielanforderung

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

Definitionen

Name	Beschreibung
DateTimeRange	Der Zeitbereich. Darf nicht NULL oder negativ sein.
EventProperty	Eigenschaft eines Ereignisses, das entweder gespeichert oder berechnet wird. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen.
EventSchema	Ereignisschema aller Ereignisse innerhalb einer bestimmten Suchspanne. Ereignisschema ist ein Satz von Eigenschaftendefinitionen. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen. Das Ereignisschema enthält möglicherweise nicht alle persistenten Eigenschaften, wenn zu viele Eigenschaften vorhanden sind.
GetEventSchemaRequest	Anforderung zum Abrufen des Ereignisschemas aller Ereignisse innerhalb einer bestimmten Suchspanne.
PropertyTypes	Den Typ der Eigenschaft.
TsiError	Informationen zu einem API-Fehler.
TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails	Zusätzliche Fehlerinformationen.

DateTimeRange

Der Zeitbereich. Darf nicht NULL oder negativ sein.

Name	Typ	Beschreibung
from	string	Startzeitstempel des Zeitbereichs. Der Startzeitstempel ist inklusive, wenn er in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die über diesen Zeitstempel verfügen, werden eingeschlossen.
to	string	Endzeitstempel des Zeitbereichs. Endzeitstempel ist exklusiv, wenn es in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die mit diesem Zeitstempel übereinstimmen, werden ausgeschlossen. Beachten Sie, dass der Endzeitstempel inklusive ist, wenn er von Get Availability zurückgegeben wird (was bedeutet, dass ein Ereignis mit genau diesem Zeitstempel "to" vorhanden ist).

EventProperty

Eigenschaft eines Ereignisses, das entweder gespeichert oder berechnet wird. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen.

Name	Typ	Beschreibung
name	string	Den Namen der Eigenschaft.
type	PropertyTypes	Den Typ der Eigenschaft.

EventSchema

Ereignisschema aller Ereignisse innerhalb einer bestimmten Suchspanne. Ereignisschema ist ein Satz von Eigenschaftendefinitionen. Eigenschaften werden sowohl anhand des Namens als auch des Typs identifiziert. Verschiedene Ereignisse können Eigenschaften mit demselben Namen, aber einem anderen Typ aufweisen. Das Ereignisschema enthält möglicherweise nicht alle persistenten Eigenschaften, wenn zu viele Eigenschaften vorhanden sind.

Name	Typ	Beschreibung
properties	EventProperty[]	Ein Satz von Eigenschaftendefinitionen. Wenn die Umgebung keine Daten enthält, ist das zurückgegebene Array leer.

GetEventSchemaRequest

Anforderung zum Abrufen des Ereignisschemas aller Ereignisse innerhalb einer bestimmten Suchspanne.

Name	Typ	Beschreibung
searchSpan	DateTimeRange	Der Zeitbereich, in dem die Abfrage ausgeführt wird. Darf nicht NULL sein.

PropertyTypes

Den Typ der Eigenschaft.

Name	Typ	Beschreibung
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	TsiErrorDetails[]	Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.
innerError	TsiErrorBody	Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message	string	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target	string	Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message	string	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.

Freigeben über

Query - Get Event Schema

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ColdStoreEventSchemaGet

Beispielanforderung

Beispiel für eine Antwort

EventSchemaGet

Beispielanforderung

Beispiel für eine Antwort

EventSchemaGetEmpty

Beispielanforderung

Beispiel für eine Antwort

WarmStoreEventSchemaGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Zusätzliche Ressourcen