Query - Get Event Schema

Odwołanie

Usługa:: Time Series Insights

Wersja interfejsu API:: 2020-07-31

Zwraca schemat zdarzeń środowiska dla danego zakresu wyszukiwania. Schemat zdarzeń to zestaw definicji właściwości. Schemat zdarzenia może nie zawierać wszystkich utrwalone właściwości, jeśli istnieje zbyt wiele właściwości.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
environmentFqdn	path	True	string	Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, Azure Portal lub usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".
storeType	query		string	W środowiskach z włączonym ciepłym magazynem można wykonać zapytanie w magazynie "WarmStore" lub "ColdStore". Ten parametr w zapytaniu definiuje, w którym magazynie ma być wykonywane zapytanie. Jeśli nie zostanie zdefiniowana, zapytanie zostanie wykonane w magazynie zimnym.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string	Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą konkretnego żądania.
x-ms-client-session-id		string	Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji w usługach i umożliwia klientowi kontaktowanie się z pomocą techniczną w odniesieniu do określonej grupy żądań.

Treść żądania

Nazwa	Wymagane	Typ	Opis
searchSpan	True	DateTimeRange	Zakres czasu wykonywania zapytania. Nie może mieć wartości null.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EventSchema	Operacja zakończona powodzeniem. Nagłówki x-ms-request-id: string
Other Status Codes	TsiError	Nieoczekiwany błąd. Nagłówki x-ms-request-id: string

Nazwa

Typ

Opis

200 OK

EventSchema

Operacja zakończona powodzeniem.

Nagłówki

x-ms-request-id: string

Other Status Codes

TsiError

Nieoczekiwany błąd.

Nagłówki

x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
DateTimeRange	Zakres czasu. Nie może mieć wartości null ani ujemnej.
EventProperty	Właściwość zdarzenia, które jest przechowywane lub obliczane. Właściwości są identyfikowane zarówno przez nazwę, jak i typ. Różne zdarzenia mogą mieć właściwości o tej samej nazwie, ale różne typy.
EventSchema	Schemat zdarzeń wszystkich zdarzeń w ramach danego zakresu wyszukiwania. Schemat zdarzeń to zestaw definicji właściwości. Właściwości są identyfikowane zarówno przez nazwę, jak i typ. Różne zdarzenia mogą mieć właściwości o tej samej nazwie, ale różne typy. Schemat zdarzenia może nie zawierać wszystkich utrwalone właściwości, jeśli istnieje zbyt wiele właściwości.
GetEventSchemaRequest	Żądanie pobrania schematu zdarzeń wszystkich zdarzeń w danym zakresie wyszukiwania.
PropertyTypes	Typ właściwości.
TsiError	Informacje o błędzie interfejsu API.
TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails	Dodatkowe informacje o błędzie.

DateTimeRange

Zakres czasu. Nie może mieć wartości null ani ujemnej.

Nazwa	Typ	Opis
from	string	Znacznik czasu rozpoczęcia zakresu czasu. Znacznik czasu rozpoczęcia jest uwzględniany w przypadku użycia w żądaniach zapytań szeregów czasowych. Uwzględniane są zdarzenia, które mają ten znacznik czasu.
to	string	Znacznik czasu zakończenia zakresu czasu. Sygnatura czasowa zakończenia jest wyłączna w przypadku użycia w żądaniach zapytań szeregów czasowych. Zdarzenia pasujące do tego znacznika czasu są wykluczone. Należy pamiętać, że znacznik czasu zakończenia jest uwzględniany po zwróceniu przez polecenie Pobierz dostępność (co oznacza, że istnieje zdarzenie z tym dokładnym znacznikiem czasu "do").

EventProperty

Właściwość zdarzenia, które jest przechowywane lub obliczane. Właściwości są identyfikowane zarówno przez nazwę, jak i typ. Różne zdarzenia mogą mieć właściwości o tej samej nazwie, ale różne typy.

Nazwa	Typ	Opis
name	string	Nazwa właściwości.
type	PropertyTypes	Typ właściwości.

EventSchema

Schemat zdarzeń wszystkich zdarzeń w ramach danego zakresu wyszukiwania. Schemat zdarzeń to zestaw definicji właściwości. Właściwości są identyfikowane zarówno przez nazwę, jak i typ. Różne zdarzenia mogą mieć właściwości o tej samej nazwie, ale różne typy. Schemat zdarzenia może nie zawierać wszystkich utrwalone właściwości, jeśli istnieje zbyt wiele właściwości.

Nazwa	Typ	Opis
properties	EventProperty[]	Zestaw definicji właściwości. Gdy środowisko nie ma danych, zwracana tablica jest pusta.

GetEventSchemaRequest

Żądanie pobrania schematu zdarzeń wszystkich zdarzeń w danym zakresie wyszukiwania.

Nazwa	Typ	Opis
searchSpan	DateTimeRange	Zakres czasu wykonywania zapytania. Nie może mieć wartości null.

PropertyTypes

Typ właściwości.

Nazwa	Typ	Opis
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

Informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details	TsiErrorDetails[]	Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError	TsiErrorBody	Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Dodatkowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.

Udostępnij za pośrednictwem

Query - Get Event Schema

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ColdStoreEventSchemaGet

Przykładowe żądanie

Przykładowa odpowiedź

EventSchemaGet

Przykładowe żądanie

Przykładowa odpowiedź

EventSchemaGetEmpty

Przykładowe żądanie

Przykładowa odpowiedź

WarmStoreEventSchemaGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Dodatkowe zasoby