Time Series Types - List

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

Возвращает типы временных рядов на страницах.

GET https://{environmentFqdn}/timeseries/types?api-version=2020-07-31

Параметры URI

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API get Environments, портал Azure или Azure Resource Manager.
api-version	query	True	string	Версия API, используемая с клиентским запросом. Сейчас поддерживается версия 2020-07-31.

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

Name	Type	Description
x-ms-continuation	string	Маркер продолжения с предыдущей страницы результатов для получения следующей страницы результатов в вызовах, поддерживающих разбиение на страницы. Чтобы получить результаты первой страницы, укажите токен продолжения NULL в качестве значения параметра. Возвращенный маркер продолжения имеет значение NULL, если возвращены все результаты и не существует следующей страницы результатов.
x-ms-client-request-id	string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки в отношении конкретного запроса.
x-ms-client-session-id	string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки в отношении определенной группы запросов.

Ответы

Name	Type	Description
200 OK	GetTypesPage	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Name

Type

Description

200 OK

GetTypesPage

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

Headers

x-ms-request-id: string

Other Status Codes

TsiError

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

Headers

x-ms-request-id: string

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

TypesListPage1

TypesListPage2

TypesListPage3

TypesListPage1

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

TypesListPage2

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "TurbineSensor",
      "description": "Wind turbine sensor",
      "variables": {
        "Value": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.value.Double"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

TypesListPage3

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample Response

Status code:: 200

{
  "types": []
}

Определения

AggregateVariable	Агрегатная переменная представляет любое вычисление агрегирования. Агрегатные переменные не поддерживают интерполяцию.
Boundary	Диапазон времени слева и справа от диапазона поиска, который будет использоваться для интерполяции. Это полезно в сценариях, когда точки данных отсутствуют близко к началу или концу входного диапазона поиска. Может быть равен null.
CategoricalVariable	Категориальная переменная представляет сигнал, который необходимо проанализировать на основе количества или длительности вхождения ограниченного набора определенных значений.
GetTypesPage	Частичный список типов временных рядов, возвращаемых в одном запросе.
Interpolation	Операция интерполяции, выполняемая для необработанных точек данных. В настоящее время разрешена только выборка интерполированных временных рядов. Разрешенная агрегатная функция, например left($value). Может иметь значение NULL, если интерполяция не требуется применять.
InterpolationKind	Тип метода интерполяции: Linear или Step.
NumericVariable	Числовая переменная представляет собой один непрерывный числовый сигнал, который можно воссоздать с помощью интерполяции.
TimeSeriesAggregateCategory	Категория, используемая в категориальных переменных. Категория определяется меткой и "значениями", назначенными этой меткой.
TimeSeriesDefaultCategory	Представляет категорию по умолчанию.
TimeSeriesType	Тип временных рядов определяет переменные или формулы для вычисления событий, связанных с экземплярами временных рядов. Каждый экземпляр временных рядов связан с одним типом. Один тип может содержать одну или несколько переменных. Например, экземпляр временных рядов может иметь тип датчика температуры, который состоит из переменных среднее значение температуры, минимальной температуры и максимальной температуры.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.
Tsx	Выражение временных рядов (TSX), написанное как одна строка. Примеры: "$event. Status.String='Good', "avg($event. Температура)". См. документацию по написанию выражений временных рядов.

AggregateVariable

Агрегатная переменная представляет любое вычисление агрегирования. Агрегатные переменные не поддерживают интерполяцию.

Name	Type	Description
aggregation	Tsx	Выражение временных рядов агрегирования, если тип является "агрегатным" используется для представления агрегата, который необходимо выполнить непосредственно с помощью таких свойств событий, как "$event". Температура". Например, агрегирование для вычисления диапазона изменений температуры можно записать следующим образом: "max($event. Temperature)-min($event. Температура)".
filter	Tsx	Фильтрация по событиям, ограничивающим количество событий, которые рассматриваются для вычислений. Пример: "$event. Status.String='Good'". Необязательный элемент.
kind	string: aggregate	Допустимые значения kind: "numeric" или "aggregate". Хотя "числовой" позволяет указать значение восстановленного сигнала и выражение для их агрегирования, тип "агрегат" позволяет напрямую агрегировать свойства события без указания значения.

Boundary

Диапазон времени слева и справа от диапазона поиска, который будет использоваться для интерполяции. Это полезно в сценариях, когда точки данных отсутствуют близко к началу или концу входного диапазона поиска. Может быть равен null.

Name	Type	Description
span	string

CategoricalVariable

Категориальная переменная представляет сигнал, который необходимо проанализировать на основе количества или длительности вхождения ограниченного набора определенных значений.

Name	Type	Description
categories	TimeSeriesAggregateCategory[]	Категория, используемая в категориальных переменных. Категория определяется меткой и "значениями", назначенными этой меткой.
defaultCategory	TimeSeriesDefaultCategory	Представляет категорию по умолчанию.
filter	Tsx	Фильтрация по событиям, ограничивающим количество событий, которые рассматриваются для вычислений. Пример: "$event. Status.String='Good'". Необязательный элемент.
interpolation	Interpolation	Категориальная переменная поддерживает только интерполяцию step.
kind	string: categorical	Допустимые значения kind: "numeric" или "aggregate". Хотя "числовой" позволяет указать значение восстановленного сигнала и выражение для их агрегирования, тип "агрегат" позволяет напрямую агрегировать свойства события без указания значения.
value	Tsx	Выражение временных рядов используется для представления значения сигнала, который будет классифицироваться. Он может вычислить только тип String или Long для категориальных переменных.

GetTypesPage

Частичный список типов временных рядов, возвращаемых в одном запросе.

Name	Type	Description
continuationToken	string	При возвращении это означает, что текущие результаты представляют частичный результат. Токен продолжения позволяет получить следующую страницу результатов. Чтобы получить следующую страницу результатов запроса, отправьте тот же запрос с параметром токена продолжения в заголовке HTTP x-ms-continuation.
types	TimeSeriesType[]	Частичный список типов временных рядов, возвращаемых в одном запросе. Может быть пустым, если серверу не удалось заполнить страницу дополнительными типами в этом запросе или больше типов, если маркер продолжения имеет значение NULL.

Interpolation

Операция интерполяции, выполняемая для необработанных точек данных. В настоящее время разрешена только выборка интерполированных временных рядов. Разрешенная агрегатная функция, например left($value). Может иметь значение NULL, если интерполяция не требуется применять.

Name	Type	Description
boundary	Boundary	Диапазон времени слева и справа от диапазона поиска, который будет использоваться для интерполяции. Это полезно в сценариях, когда точки данных отсутствуют близко к началу или концу входного диапазона поиска. Может быть равен null.
kind	InterpolationKind	Тип метода интерполяции: Linear или Step.

InterpolationKind

Тип метода интерполяции: Linear или Step.

Name	Type	Description
Linear	string
Step	string

NumericVariable

Числовая переменная представляет собой один непрерывный числовый сигнал, который можно воссоздать с помощью интерполяции.

Name	Type	Description
aggregation	Tsx	Выражение временного ряда агрегирования, если для представления статистической обработки, необходимой для $value выражения, используется тип "числовой". Для этого необходимо указать $value и использовать только $value внутри агрегатных функций. Например, агрегирование для вычисления минимума $value записывается как "min($value)".
filter	Tsx	Фильтрация по событиям, ограничивающим количество событий, которые рассматриваются для вычислений. Пример: "$event. Status.String='Good'". Необязательный элемент.
interpolation	Interpolation	Операция интерполяции, выполняемая для необработанных точек данных. В настоящее время разрешена только выборка интерполированных временных рядов. Разрешенная агрегатная функция, например left($value). Может иметь значение NULL, если интерполяция не требуется применять.
kind	string: numeric	Допустимые значения kind: "numeric" или "aggregate". Хотя "числовой" позволяет указать значение восстановленного сигнала и выражение для их агрегирования, тип "агрегат" позволяет напрямую агрегировать свойства события без указания значения.
value	Tsx	Выражение временных рядов значений используется для представления значения сигнала, который будет агрегироваться или интерполироваться. Например, значения температуры события представлены следующим образом: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Категория, используемая в категориальных переменных. Категория определяется меткой и "значениями", назначенными этой меткой.

Name	Type	Description
label	string	Имя категории, которая будет использоваться при создании имен выходных переменных.
values	object[]	Список значений, с которым сопоставляется категория. Может быть уникальным списком строк или длинным списком.

TimeSeriesDefaultCategory

Представляет категорию по умолчанию.

Name	Type	Description
label	string	Имя категории по умолчанию, которая будет назначена значениям, которые не соответствуют ни одному из тех, которые определены в категории.

TimeSeriesType

Тип временных рядов определяет переменные или формулы для вычисления событий, связанных с экземплярами временных рядов. Каждый экземпляр временных рядов связан с одним типом. Один тип может содержать одну или несколько переменных. Например, экземпляр временных рядов может иметь тип датчика температуры, который состоит из переменных среднее значение температуры, минимальной температуры и максимальной температуры.

Name	Type	Description
description	string	Описание типа. Может принимать значение NULL.
id	string	Уникальный идентификатор уникального типа с учетом регистра, неизменяемый. Может иметь значение NULL при создании или обновлении запросов, а затем сервер создает идентификатор. Не имеет значения NULL при операциях получения и удаления.
name	string	Уникальное имя типа, заданное пользователем. Изменяемый, а не null.
variables	object	Различные переменные, связанные с типом. Не пустой, а не null.

TsiError

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

Name	Type	Description
error	TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

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

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

TsiErrorDetails

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

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

Tsx

Выражение временных рядов (TSX), написанное как одна строка. Примеры: "$event. Status.String='Good', "avg($event. Температура)". См. документацию по написанию выражений временных рядов.

Name	Type	Description
tsx	string	Выражение временных рядов (TSX), написанное как одна строка. Примеры: "$event. Status.String='Good', "avg($event. Температура)". См. документацию по написанию выражений временных рядов.