Query - Get Event Schema

Riferimento

Service:: Time Series Insights

API Version:: 2020-07-31

Restituisce lo schema dell'evento di ambiente per un determinato intervallo di ricerca. Lo schema eventi è un set di definizioni delle proprietà. Lo schema eventi potrebbe non contenere tutte le proprietà persistenti quando sono presenti troppe proprietà.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentFqdn	path	True	string	Per FQDN dell'ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environment, portale di Azure o Azure Resource Manager.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31".
storeType	query		string	Per gli ambienti con l'archivio ad accesso frequente abilitato, la query può essere eseguita in 'WarmStore' o 'ColdStore'. Questo parametro nella query definisce l'archivio in cui quest'ultima deve essere eseguita. Se non è definito, la query verrà eseguita nell'archivio ad accesso sporadico.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string	ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare l'operazione tra i servizi e consente al cliente di contattare il supporto tecnico per una richiesta specifica.
x-ms-client-session-id		string	ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico per un determinato gruppo di richieste.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
searchSpan	True	DateTimeRange	Intervallo di tempo in cui viene eseguita la query. Non può essere null.

Risposte

Nome	Tipo	Descrizione
200 OK	EventSchema	Operazione riuscita. Headers x-ms-request-id: string
Other Status Codes	TsiError	Errore imprevisto. Headers x-ms-request-id: string

Nome

Tipo

Descrizione

200 OK

EventSchema

Operazione riuscita.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Errore imprevisto.

Headers

x-ms-request-id: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
DateTimeRange	Intervallo di tempo. Non può essere null o negativo.
EventProperty	Proprietà di un evento archiviato o calcolato. Le proprietà vengono identificate sia dal nome che dal tipo. Gli eventi diversi possono avere proprietà con lo stesso nome, ma un tipo diverso.
EventSchema	Schema di eventi di tutti gli eventi all'interno di un determinato intervallo di ricerca. Lo schema eventi è un set di definizioni delle proprietà. Le proprietà vengono identificate sia dal nome che dal tipo. Gli eventi diversi possono avere proprietà con lo stesso nome, ma un tipo diverso. Lo schema eventi potrebbe non contenere tutte le proprietà persistenti quando sono presenti troppe proprietà.
GetEventSchemaRequest	Richiedere di ottenere lo schema eventi di tutti gli eventi all'interno di un determinato intervallo di ricerca.
PropertyTypes	Tipo della proprietà.
TsiError	Informazioni su un errore dell'API.
TsiErrorBody	Errore dell'API specifico con un codice di errore e un messaggio.
TsiErrorDetails	Informazioni aggiuntive sugli errori.

DateTimeRange

Intervallo di tempo. Non può essere null o negativo.

Nome	Tipo	Descrizione
from	string	Timestamp di inizio dell'intervallo di tempo. Il timestamp di inizio è inclusivo quando viene usato nelle richieste di query della serie temporale. Gli eventi con questo timestamp sono inclusi.
to	string	Timestamp di fine dell'intervallo di tempo. Il timestamp di fine è esclusivo quando viene usato nelle richieste di query della serie temporale. Gli eventi corrispondenti a questo timestamp sono esclusi. Si noti che il timestamp di fine è inclusivo quando restituito da Get Availability (ovvero è presente un evento con questo timestamp esatto "to").

EventProperty

Proprietà di un evento archiviato o calcolato. Le proprietà vengono identificate sia dal nome che dal tipo. Gli eventi diversi possono avere proprietà con lo stesso nome, ma un tipo diverso.

Nome	Tipo	Descrizione
name	string	Nome della proprietà.
type	PropertyTypes	Tipo della proprietà.

EventSchema

Schema di eventi di tutti gli eventi all'interno di un determinato intervallo di ricerca. Lo schema eventi è un set di definizioni delle proprietà. Le proprietà vengono identificate sia dal nome che dal tipo. Gli eventi diversi possono avere proprietà con lo stesso nome, ma un tipo diverso. Lo schema eventi potrebbe non contenere tutte le proprietà persistenti quando sono presenti troppe proprietà.

Nome	Tipo	Descrizione
properties	EventProperty[]	Set di definizioni delle proprietà. Quando l'ambiente non dispone di dati, la matrice restituita è vuota.

GetEventSchemaRequest

Richiedere di ottenere lo schema eventi di tutti gli eventi all'interno di un determinato intervallo di ricerca.

Nome	Tipo	Descrizione
searchSpan	DateTimeRange	Intervallo di tempo in cui viene eseguita la query. Non può essere null.

PropertyTypes

Tipo della proprietà.

Nome	Tipo	Descrizione
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

Informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	TsiErrorBody	Errore dell'API specifico con un codice di errore e un messaggio.

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
details	TsiErrorDetails[]	Contiene informazioni aggiuntive sugli errori. Può essere Null.
innerError	TsiErrorBody	Contiene un errore più specifico che restringe la causa. Può essere Null.
message	string	Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.
target	string	Destinazione del particolare errore (ad esempio, il nome della proprietà in errore). Può essere Null.

TsiErrorDetails

Informazioni aggiuntive sugli errori.

Nome	Tipo	Descrizione
code	string	Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
message	string	Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.

Share via

Query - Get Event Schema

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Definizioni

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Risorse aggiuntive