Dela via

Query - Get Event Schema

Tjänst:
Time Series Insights
API-version:
2020-07-31

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

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31
Med valfria parametrar: 
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 varmlagring 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 det möjligt för kunden att 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 det möjligt för kunden att kontakta supporten om en viss grupp med begäranden.

Begärandetext

Name Obligatorisk Typ Description
searchSpan True

DateTimeRange

Det tidsintervall som frågan körs på. Det går inte att vara null.

Svar

Name Typ Description
200 OK

EventSchema

Åtgärden lyckades.

Sidhuvuden

x-ms-request-id: string
Other Status Codes

TsiError

Oväntat fel.

Sidhuvuden

x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ColdStoreEventSchemaGet
EventSchemaGet
EventSchemaGetEmpty
WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "properties": []
}

WarmStoreEventSchemaGet

Exempelbegäran

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

Exempelsvar

Statuskod:
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 bevarade egenskaper när det finns för många egenskaper.
GetEventSchemaRequest

Begär att få 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

Objekt

Tidsintervallet. Får inte vara null eller negativt.

Name Typ Description
from

string (date-time)

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 (date-time)

Sluttidsstämpel för tidsintervallet. Sluttidsstämpeln är exklusiv när den används i frågebegäranden för 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

Objekt

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

Objekt

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 bevarade egenskaper när det finns för många egenskaper.

Name Typ Description
properties

EventProperty[]

En uppsättning egenskapsdefinitioner. När miljön inte har några data är den returnerade matrisen tom.

GetEventSchemaRequest

Objekt

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

Name Typ Description
searchSpan

DateTimeRange

Det tidsintervall som frågan körs på. Det går inte att vara null.

PropertyTypes

Uppräkning

Egenskapens typ.

Värde Description
Bool
DateTime
Double
String
TimeSpan
Long

TsiError

Objekt

Information om ett API-fel.

Name Typ Description
error

TsiErrorBody

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

TsiErrorBody

Objekt

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ålet för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Objekt

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.