Query - Get Event Schema

Referens

Service:: Time Series Insights

API Version:: 2020-07-31

Returnerar miljöhändelseschemat för ett givet sökintervall. Händelseschema är en uppsättning egenskapsdefinitioner. Händelseschemat kanske inte innehåller alla beständiga egenskaper när det finns för många egenskaper.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentFqdn	path	True	string	FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från GET Environments API, Azure Portal eller Azure Resource Manager.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".
storeType	query		string	För miljöer med varmt arkiv aktiverat kan frågan köras antingen på "WarmStore" eller "ColdStore". Den här parametern i frågan definierar vilket lager frågan ska köras på. Om den inte har definierats körs frågan i det kalla arkivet.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string	Valfritt klientbegärans-ID. Tjänsten registrerar det här värdet. Tillåter att tjänsten spårar åtgärder mellan tjänster och gör att kunden kan kontakta supporten angående en viss begäran.
x-ms-client-session-id		string	Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör att kunden kan kontakta supporten för en viss grupp med begäranden.

Begärandetext

Name	Obligatorisk	Typ	Description
searchSpan	True	DateTimeRange	Tidsintervallet då frågan körs. Kan inte vara null.

Svar

Name	Typ	Description
200 OK	EventSchema	Åtgärden lyckades. Headers x-ms-request-id: string
Other Status Codes	TsiError	Oväntat fel. Headers x-ms-request-id: string

Name

Typ

Description

200 OK

EventSchema

Åtgärden lyckades.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Oväntat fel.

Headers

x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Sample Request

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"
  }
}

Sample Response

Status code:: 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

Sample Request

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"
  }
}

Sample Response

Status code:: 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

Sample Request

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"
  }
}

Sample Response

Status code:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Sample Request

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"
  }
}

Sample Response

Status code:: 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"
    }
  ]
}

Definitioner

Name	Description
DateTimeRange	Tidsintervallet. Får inte vara null eller negativt.
EventProperty	Egenskapen för en händelse som antingen lagras eller beräknas. Egenskaper identifieras med både namn och typ. Olika händelser kan ha egenskaper med samma namn, men olika typer.
EventSchema	Händelseschema för alla händelser inom ett visst sökintervall. Händelseschema är en uppsättning egenskapsdefinitioner. Egenskaper identifieras med både namn och typ. Olika händelser kan ha egenskaper med samma namn, men olika typer. Händelseschemat kanske inte innehåller alla beständiga egenskaper när det finns för många egenskaper.
GetEventSchemaRequest	Begäran om att hämta händelseschemat för alla händelser inom ett visst sökintervall.
PropertyTypes	Egenskapens typ.
TsiError	Information om ett API-fel.
TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails	Ytterligare felinformation.

DateTimeRange

Tidsintervallet. Får inte vara null eller negativt.

Name	Typ	Description
from	string	Starttidsstämpel för tidsintervallet. Starttidsstämpeln är inkluderande när den används i frågebegäranden för tidsserier. Händelser som har den här tidsstämpeln ingår.
to	string	Sluttidsstämpel för tidsintervallet. Sluttidsstämpeln är exklusiv när den används i frågebegäranden i tidsserier. Händelser som matchar den här tidsstämpeln undantas. Observera att sluttidsstämpeln är inkluderande när den returneras av Hämta tillgänglighet (vilket innebär att det finns en händelse med den här exakta "till"-tidsstämpeln).

EventProperty

Egenskapen för en händelse som antingen lagras eller beräknas. Egenskaper identifieras med både namn och typ. Olika händelser kan ha egenskaper med samma namn, men olika typer.

Name	Typ	Description
name	string	Namnet på egenskapen.
type	PropertyTypes	Egenskapens typ.

EventSchema

Händelseschema för alla händelser inom ett visst sökintervall. Händelseschema är en uppsättning egenskapsdefinitioner. Egenskaper identifieras med både namn och typ. Olika händelser kan ha egenskaper med samma namn, men olika typer. Händelseschemat kanske inte innehåller alla beständiga egenskaper när det finns för många egenskaper.

Name	Typ	Description
properties	EventProperty[]	En uppsättning egenskapsdefinitioner. När miljön inte innehåller några data är den returnerade matrisen tom.

GetEventSchemaRequest

Begäran om att hämta händelseschemat för alla händelser inom ett visst sökintervall.

Name	Typ	Description
searchSpan	DateTimeRange	Tidsintervallet då frågan körs. Kan inte vara null.

PropertyTypes

Egenskapens typ.

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

TsiError

Information om ett API-fel.

Name	Typ	Description
error	TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details	TsiErrorDetails[]	Innehåller ytterligare felinformation. Kan vara null.
innerError	TsiErrorBody	Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target	string	Mål för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Ytterligare felinformation.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.

Share via

Query - Get Event Schema

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Definitioner

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Ytterligare resurser