Query - Get Event Schema

  • Referência
Serviço:
Time Series Insights
Versão da API:
2020-07-31

Devolve o esquema de eventos de ambiente para um determinado período de pesquisa. O esquema de eventos é um conjunto de definições de propriedades. O esquema de eventos pode não conter todas as propriedades persistentes quando existem demasiadas propriedades.

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31
Com parâmetros opcionais: 
POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

Parâmetros do URI

Name Em Necessário Tipo Description
environmentFqdn
 path True

string

Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Pode obter este nome de domínio a partir da resposta da API Get Environments, portal do Azure ou do Azure Resource Manager.
api-version
 query True

string

Versão da API a utilizar com o pedido de cliente. A versão atualmente suportada é "2020-07-31".
storeType
 query

string

Para os ambientes com o arquivo quente ativado, a consulta pode ser executada no "WarmStore" ou no "ColdStore". Este parâmetro na consulta define em que arquivo a consulta deve ser executada. Se não estiver definida, a consulta será executada no arquivo a frio.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string

ID de pedido de cliente opcional. O serviço regista este valor. Permite ao serviço rastrear a operação entre serviços e permite que o cliente contacte o suporte relativamente a um pedido específico.
x-ms-client-session-id

string

ID de sessão de cliente opcional. O serviço regista este valor. Permite ao serviço rastrear um grupo de operações relacionadas entre serviços e permite que o cliente contacte o suporte relativamente a um determinado grupo de pedidos.

Corpo do Pedido

Name Necessário Tipo Description
searchSpan True

DateTimeRange

O intervalo de tempo em que a consulta é executada. Não pode ser nulo.

Respostas

Name Tipo Description
200 OK

EventSchema

Operação bem-sucedida.

Cabeçalhos

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

TsiError

Erro inesperado.

Cabeçalhos

x-ms-request-id: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ColdStoreEventSchemaGet
EventSchemaGet
EventSchemaGetEmpty
WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "properties": []
}

WarmStoreEventSchemaGet

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name Description
DateTimeRange

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

Propriedade de um evento armazenado ou calculado. As propriedades são identificadas pelo nome e pelo tipo. Diferentes eventos podem ter propriedades com o mesmo nome, mas com um tipo diferente.
EventSchema

Esquema de eventos de todos os eventos num determinado período de pesquisa. O esquema de eventos é um conjunto de definições de propriedades. As propriedades são identificadas pelo nome e pelo tipo. Diferentes eventos podem ter propriedades com o mesmo nome, mas com um tipo diferente. O esquema de eventos pode não conter todas as propriedades persistentes quando existem demasiadas propriedades.
GetEventSchemaRequest

Pedido para obter o esquema de eventos de todos os eventos num determinado período de pesquisa.
PropertyTypes

O tipo da propriedade.
TsiError

Informações sobre um erro de API.
TsiErrorBody

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

Informações de erro adicionais.

DateTimeRange

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

Name Tipo Description
from

string

Carimbo de data/hora de início do intervalo de tempo. O carimbo de data/hora de início é inclusivo quando utilizado em pedidos de consulta de série temporal. Estão incluídos eventos com este carimbo de data/hora.
to

string

Carimbo de data/hora de fim do intervalo de tempo. O carimbo de data/hora de fim é exclusivo quando utilizado em pedidos de consulta de série temporal. Os eventos que correspondam a este carimbo de data/hora são excluídos. Tenha em atenção que o carimbo de data/hora de fim é inclusivo quando devolvido por Obter Disponibilidade (o que significa que existe um evento com este carimbo de data/hora exato "para").

EventProperty

Propriedade de um evento armazenado ou calculado. As propriedades são identificadas pelo nome e pelo tipo. Diferentes eventos podem ter propriedades com o mesmo nome, mas com um tipo diferente.

Name Tipo Description
name

string

O nome da propriedade.
type

PropertyTypes

O tipo da propriedade.

EventSchema

Esquema de eventos de todos os eventos num determinado período de pesquisa. O esquema de eventos é um conjunto de definições de propriedades. As propriedades são identificadas pelo nome e pelo tipo. Diferentes eventos podem ter propriedades com o mesmo nome, mas com um tipo diferente. O esquema de eventos pode não conter todas as propriedades persistentes quando existem demasiadas propriedades.

Name Tipo Description
properties

EventProperty[]

Um conjunto de definições de propriedades. Quando o ambiente não tem dados, a matriz devolvida está vazia.

GetEventSchemaRequest

Pedido para obter o esquema de eventos de todos os eventos num determinado período de pesquisa.

Name Tipo Description
searchSpan

DateTimeRange

O intervalo de tempo em que a consulta é executada. Não pode ser nulo.

PropertyTypes

O tipo da propriedade.

Name Tipo Description
Bool

string

DateTime

string

Double

string

Long

string

String

string

TimeSpan

string

TsiError

Informações sobre um erro de API.

Name Tipo Description
error

TsiErrorBody

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

TsiErrorBody

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

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente 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 reduz a causa. Pode ser nulo.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.
target

string

Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações de erro adicionais.

Name Tipo Description
code

string

Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos.
message

string

Representação legível por humanos e independente da linguagem do erro. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.