Query - Get Event Schema

Referência

Service:: Time Series Insights

API Version:: 2020-07-31

Retorna o esquema de evento de ambiente para um determinado intervalo de pesquisa. O esquema de eventos é um conjunto de definições de propriedade. O esquema de evento pode não conter todas as propriedades persistentes quando há muitas propriedades.

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atualmente com suporte é "2020-07-31".
storeType	query		string	Para os ambientes com o repositório warm habilitado, a consulta pode ser executada no 'WarmStore' ou 'ColdStore'. Esse parâmetro na consulta define em qual armazenamento a consulta deve ser executada. Se ele não estiver definido, a consulta será executada no armazenamento cold.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string	ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id		string	ID de sessão do cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
searchSpan	True	DateTimeRange	O intervalo de tempo no qual a consulta é executada. Não pode ser nulo.

Respostas

Nome	Tipo	Description
200 OK	EventSchema	Operação com êxito. Headers x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Headers x-ms-request-id: string

Nome

Tipo

Description

200 OK

EventSchema

Operação com êxito.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Erro inesperado.

Headers

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
DateTimeRange	O intervalo de tempo. Não pode ser nulo ou negativo.
EventProperty	Propriedade de um evento armazenado ou computado. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente.
EventSchema	Esquema de eventos de todos os eventos em um determinado intervalo de pesquisa. O esquema de eventos é um conjunto de definições de propriedade. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente. O esquema de evento pode não conter todas as propriedades persistentes quando há muitas propriedades.
GetEventSchemaRequest	Solicitação para obter o esquema de evento de todos os eventos dentro de um determinado intervalo de pesquisa.
PropertyTypes	O tipo da propriedade.
TsiError	Informações sobre um erro de API.
TsiErrorBody	Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails	Informações adicionais de erro.

DateTimeRange

O intervalo de tempo. Não pode ser nulo ou negativo.

Nome	Tipo	Description
from	string	Iniciar carimbo de data/hora do intervalo de tempo. O carimbo de data/hora de início é inclusivo quando usado em solicitações de consulta de série temporal. Os eventos que têm esse carimbo de data/hora são incluídos.
to	string	Carimbo de data/hora final do intervalo de tempo. O carimbo de data/hora final é exclusivo quando usado em solicitações de consulta de série temporal. Os eventos que correspondem a esse carimbo de data/hora são excluídos. Observe que o carimbo de data/hora final é inclusivo quando retornado por Obter Disponibilidade (o que significa que há um evento com esse carimbo de data/hora "to" exato).

EventProperty

Propriedade de um evento armazenado ou computado. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente.

Nome	Tipo	Description
name	string	O nome da propriedade.
type	PropertyTypes	O tipo da propriedade.

EventSchema

Esquema de eventos de todos os eventos em um determinado intervalo de pesquisa. O esquema de eventos é um conjunto de definições de propriedade. As propriedades são identificadas por nome e tipo. Eventos diferentes podem ter propriedades com o mesmo nome, mas tipo diferente. O esquema de evento pode não conter todas as propriedades persistentes quando há muitas propriedades.

Nome	Tipo	Description
properties	EventProperty[]	Um conjunto de definições de propriedade. Quando o ambiente não tem dados, a matriz retornada fica vazia.

GetEventSchemaRequest

Solicitação para obter o esquema de evento de todos os eventos dentro de um determinado intervalo de pesquisa.

Nome	Tipo	Description
searchSpan	DateTimeRange	O intervalo de tempo no qual a consulta é executada. Não pode ser nulo.

PropertyTypes

O tipo da propriedade.

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

TsiError

Informações sobre um erro de API.

Nome	Tipo	Description
error	TsiErrorBody	Um erro de API específico com um código de erro e uma mensagem.

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	TsiErrorDetails[]	Contém informações de erro adicionais. Pode ser nulo.
innerError	TsiErrorBody	Contém um erro mais específico que restringe a causa. Pode ser nulo.
message	string	Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.
target	string	Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações adicionais de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message	string	Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.

Share via

Query - Get Event Schema

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Definições

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionais