Query - Get Event Schema

Referencia

Service:: Time Series Insights

API Version:: 2020-07-31

Devuelve el esquema de eventos de entorno para un intervalo de búsqueda determinado. El esquema de eventos es un conjunto de definiciones de propiedad. Es posible que el esquema de eventos no contenga todas las propiedades persistentes cuando haya demasiadas propiedades.

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 identificador URI

Nombre	En	Requerido	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31".
storeType	query		string	Para los entornos con el almacenamiento intermedio habilitado, la consulta se puede ejecutar en "WarmStore" o "ColdStore". Este parámetro de la consulta define en qué almacén debe ejecutarse la consulta. Si no se define, la consulta se ejecutará en el almacén frío.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string	Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada.
x-ms-client-session-id		string	Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
searchSpan	True	DateTimeRange	Intervalo de tiempo en el que se ejecuta la consulta. No puede ser NULL.

Respuestas

Nombre	Tipo	Description
200 OK	EventSchema	Operación correcta. Headers x-ms-request-id: string
Other Status Codes	TsiError	error inesperado. Headers x-ms-request-id: string

Nombre

Tipo

Description

200 OK

EventSchema

Operación correcta.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

error inesperado.

Headers

x-ms-request-id: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
DateTimeRange	Intervalo de tiempo. No puede ser null o negativo.
EventProperty	Propiedad de un evento que se almacena o calcula. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente.
EventSchema	Esquema de eventos de todos los eventos dentro de un intervalo de búsqueda determinado. El esquema de eventos es un conjunto de definiciones de propiedad. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente. Es posible que el esquema de eventos no contenga todas las propiedades persistentes cuando haya demasiadas propiedades.
GetEventSchemaRequest	Solicite obtener el esquema de eventos de todos los eventos dentro de un intervalo de búsqueda determinado.
PropertyTypes	Tipo de la propiedad.
TsiError	Información sobre un error de API.
TsiErrorBody	Un error de API determinado con un código de error y un mensaje.
TsiErrorDetails	Información adicional de error.

DateTimeRange

Intervalo de tiempo. No puede ser null o negativo.

Nombre	Tipo	Description
from	string	Marca de tiempo de inicio del intervalo de tiempo. La marca de tiempo de inicio es inclusiva cuando se usa en las solicitudes de consulta de serie temporal. Se incluyen eventos que tienen esta marca de tiempo.
to	string	Marca de tiempo de finalización del intervalo de tiempo. La marca de tiempo de finalización es exclusiva cuando se usa en las solicitudes de consulta de serie temporal. Los eventos que coinciden con esta marca de tiempo se excluyen. Tenga en cuenta que la marca de tiempo final es inclusiva cuando la devuelve Get Availability (lo que significa que hay un evento con esta marca de tiempo exacta de "a").

EventProperty

Propiedad de un evento que se almacena o calcula. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente.

Nombre	Tipo	Description
name	string	Nombre de la propiedad.
type	PropertyTypes	Tipo de la propiedad.

EventSchema

Esquema de eventos de todos los eventos dentro de un intervalo de búsqueda determinado. El esquema de eventos es un conjunto de definiciones de propiedad. Las propiedades se identifican por nombre y tipo. Los distintos eventos pueden tener propiedades con el mismo nombre, pero un tipo diferente. Es posible que el esquema de eventos no contenga todas las propiedades persistentes cuando haya demasiadas propiedades.

Nombre	Tipo	Description
properties	EventProperty[]	Un conjunto de definiciones de propiedad. Cuando el entorno no tiene datos, la matriz devuelta está vacía.

GetEventSchemaRequest

Solicite obtener el esquema de eventos de todos los eventos dentro de un intervalo de búsqueda determinado.

Nombre	Tipo	Description
searchSpan	DateTimeRange	Intervalo de tiempo en el que se ejecuta la consulta. No puede ser NULL.

PropertyTypes

Tipo de la propiedad.

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

TsiError

Información sobre un error de API.

Nombre	Tipo	Description
error	TsiErrorBody	Un error de API determinado con un código de error y un mensaje.

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
details	TsiErrorDetails[]	Contiene información de error adicional. Su valor puede ser null.
innerError	TsiErrorBody	Contiene un error más específico que limita la causa. Su valor puede ser null.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.
target	string	Destino del error determinado (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null.

TsiErrorDetails

Información adicional de error.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.

Query - Get Event Schema

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Definiciones

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionales