Query - Get Event Schema

Ссылка

Служба:: Time Series Insights

Версия API:: 2020-07-31

Возвращает схему событий среды для заданного диапазона поиска. Схема событий — это набор определений свойств. Схема событий может содержать не все сохраненные свойства, если свойств слишком много.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API получения сред, портал Azure или azure Resource Manager.
api-version	query	True	string	Версия API для использования с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.
storeType	query		string	Для сред с включенным теплым хранилищем запрос можно выполнить в WarmStore или ColdStore. Этот параметр в запросе определяет, в каком хранилище должен выполняться запрос. Если этот параметр не определен, запрос будет выполнен в холодном хранилище.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки по конкретному запросу.
x-ms-client-session-id		string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группы связанных операций в службах и позволяет клиенту обращаться в службу поддержки по поводу определенной группы запросов.

Текст запроса

Имя	Обязательно	Тип	Описание
searchSpan	True	DateTimeRange	Диапазон времени, в течение которого выполняется запрос. Не может иметь значение NULL.

Ответы

Имя	Тип	Описание
200 OK	EventSchema	Успешная операция. Заголовки x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Заголовки x-ms-request-id: string

Имя

Тип

Описание

200 OK

EventSchema

Успешная операция.

Заголовки

x-ms-request-id: string

Other Status Codes

TsiError

Непредвиденная ошибка.

Заголовки

x-ms-request-id: string

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Образец запроса

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Образец запроса

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
DateTimeRange	Диапазон времени. Не может иметь значение NULL или отрицательное значение.
EventProperty	Свойство события, которое либо хранится, либо вычисляется. Свойства идентифицируются по имени и типу. Разные события могут иметь свойства с одинаковым именем, но с разными типами.
EventSchema	Схема событий всех событий в пределах заданного диапазона поиска. Схема событий — это набор определений свойств. Свойства идентифицируются по имени и типу. Разные события могут иметь свойства с одинаковым именем, но с разными типами. Схема событий может содержать не все сохраненные свойства, если свойств слишком много.
GetEventSchemaRequest	Запрос на получение схемы событий для всех событий в пределах заданного диапазона поиска.
PropertyTypes	Тип свойства.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

DateTimeRange

Диапазон времени. Не может иметь значение NULL или отрицательное значение.

Имя	Тип	Описание
from	string	Начальная метка времени диапазона времени. Метка времени начала является инклюзивной при использовании в запросах временных рядов. Включаются события с этой меткой времени.
to	string	Метка времени окончания диапазона времени. Метка времени окончания является монопольной при использовании в запросах к временным рядам. События, соответствующие этой метке времени, исключаются. Обратите внимание, что метка времени окончания является инклюзивной, если она возвращается параметром Get Availability (это означает, что существует событие с этой точной меткой времени "to").

EventProperty

Свойство события, которое либо хранится, либо вычисляется. Свойства идентифицируются по имени и типу. Разные события могут иметь свойства с одинаковым именем, но с разными типами.

Имя	Тип	Описание
name	string	Имя свойства.
type	PropertyTypes	Тип свойства.

EventSchema

Схема событий всех событий в пределах заданного диапазона поиска. Схема событий — это набор определений свойств. Свойства идентифицируются по имени и типу. Разные события могут иметь свойства с одинаковым именем, но с разными типами. Схема событий может содержать не все сохраненные свойства, если свойств слишком много.

Имя	Тип	Описание
properties	EventProperty[]	Набор определений свойств. Если в среде нет данных, возвращаемый массив пуст.

GetEventSchemaRequest

Запрос на получение схемы событий для всех событий в пределах заданного диапазона поиска.

Имя	Тип	Описание
searchSpan	DateTimeRange	Диапазон времени, в течение которого выполняется запрос. Не может иметь значение NULL.

PropertyTypes

Тип свойства.

Имя	Тип	Описание
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

Сведения об ошибке API.

Имя	Тип	Описание
error	TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Конкретная ошибка API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки определенных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для доступа к конечным пользователям.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки определенных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для доступа к конечным пользователям.

Поделиться через

Query - Get Event Schema

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

ColdStoreEventSchemaGet

Образец запроса

Пример ответа

EventSchemaGet

Образец запроса

Пример ответа

EventSchemaGetEmpty

Образец запроса

Пример ответа

WarmStoreEventSchemaGet

Образец запроса

Пример ответа

Определения

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Дополнительные ресурсы