Query - Get Event Schema

Reference

Service:: Time Series Insights

API Version:: 2020-07-31

Vrátí schéma událostí prostředí pro daný rozsah hledání. Schéma událostí je sada definic vlastností. Schéma události nemusí obsahovat všechny trvalé vlastnosti, pokud existuje příliš mnoho vlastností.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentFqdn	path	True	string	Plně kvalifikovaný název domény prostředí, například 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tento název domény můžete získat z odpovědi rozhraní API Get Environment, Azure Portal nebo Azure Resource Manager.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuálně podporovaná verze je "2020-07-31".
storeType	query		string	V prostředích s povoleným teplým úložištěm je možné dotaz spustit buď na "WarmStore", nebo "ColdStore". Tento parametr v dotazu definuje, na kterém úložišti se má dotaz spustit. Pokud není definován, dotaz se spustí v chladírně.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string	Volitelné ID žádosti klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat operace napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní žádosti.
x-ms-client-session-id		string	Volitelné ID relace klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat skupinu souvisejících operací mezi službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní skupiny žádostí.

Text požadavku

Name	Vyžadováno	Typ	Description
searchSpan	True	DateTimeRange	Rozsah času, ve kterém se dotaz provádí. Nemůže mít hodnotu null.

Odpovědi

Name	Typ	Description
200 OK	EventSchema	Operace byla úspěšná. Headers x-ms-request-id: string
Other Status Codes	TsiError	Neočekávaná chyba. Headers x-ms-request-id: string

Name

Typ

Description

200 OK

EventSchema

Operace byla úspěšná.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Neočekávaná chyba.

Headers

x-ms-request-id: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
DateTimeRange	Časový rozsah. Nesmí mít hodnotu null nebo zápornou hodnotu.
EventProperty	Vlastnost události, která je uložená nebo vypočítaná. Vlastnosti jsou identifikovány názvem i typem. Různé události můžou mít vlastnosti se stejným názvem, ale jiným typem.
EventSchema	Schéma událostí všech událostí v daném rozsahu hledání. Schéma událostí je sada definic vlastností. Vlastnosti jsou identifikovány názvem i typem. Různé události můžou mít vlastnosti se stejným názvem, ale jiným typem. Schéma události nemusí obsahovat všechny trvalé vlastnosti, pokud existuje příliš mnoho vlastností.
GetEventSchemaRequest	Žádost o získání schématu událostí všech událostí v daném rozsahu hledání
PropertyTypes	Typ proměnné
TsiError	Informace o chybě rozhraní API
TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou
TsiErrorDetails	Další informace o chybě

DateTimeRange

Časový rozsah. Nesmí mít hodnotu null nebo zápornou hodnotu.

Name	Typ	Description
from	string	Časové razítko spuštění časového rozsahu Časové razítko spuštění je zahrnuté při použití v požadavcích dotazů časových řad. Jsou zahrnuty události, které mají toto časové razítko.
to	string	Koncové časové razítko časového rozsahu. Koncové časové razítko je výhradní při použití v požadavcích dotazů časových řad. Události, které odpovídají tomuto časovému razítku, jsou vyloučeny. Všimněte si, že koncové časové razítko je inkluzivní, pokud vrátí funkce Získat dostupnost (to znamená, že existuje událost s tímto přesným časovým razítkem "to").

EventProperty

Vlastnost události, která je uložená nebo vypočítaná. Vlastnosti jsou identifikovány názvem i typem. Různé události můžou mít vlastnosti se stejným názvem, ale jiným typem.

Name	Typ	Description
name	string	Název vlastnosti
type	PropertyTypes	Typ proměnné

EventSchema

Schéma událostí všech událostí v daném rozsahu hledání. Schéma událostí je sada definic vlastností. Vlastnosti jsou identifikovány názvem i typem. Různé události můžou mít vlastnosti se stejným názvem, ale jiným typem. Schéma události nemusí obsahovat všechny trvalé vlastnosti, pokud existuje příliš mnoho vlastností.

Name	Typ	Description
properties	EventProperty[]	Sada definic vlastností. Pokud prostředí neobsahuje žádná data, je vrácené pole prázdné.

GetEventSchemaRequest

Žádost o získání schématu událostí všech událostí v daném rozsahu hledání

Name	Typ	Description
searchSpan	DateTimeRange	Rozsah času, ve kterém se dotaz provádí. Nemůže mít hodnotu null.

PropertyTypes

Typ proměnné

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

TsiError

Informace o chybě rozhraní API

Name	Typ	Description
error	TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít k programovému zpracování konkrétních chybových případů.
details	TsiErrorDetails[]	Obsahuje další informace o chybách. Může mít hodnotu null.
innerError	TsiErrorBody	Obsahuje konkrétnější chybu, která zužuje příčinu. Může mít hodnotu null.
message	string	Čitelné, jazykově nezávislé znázornění chyby. Je určen jako pomoc vývojářům a není vhodný pro vystavení koncovým uživatelům.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě). Může mít hodnotu null.

TsiErrorDetails

Další informace o chybě

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít k programovému zpracování konkrétních chybových případů.
message	string	Čitelné, jazykově nezávislé znázornění chyby. Je určen jako pomoc vývojářům a není vhodný pro vystavení koncovým uživatelům.

Share via

Query - Get Event Schema

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Definice

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Další materiály