Time Series Types - Execute Batch

Ссылка

Служба:: Time Series Insights

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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.

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

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

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

Имя	Тип	Описание
delete	TypesRequestBatchGetOrDelete	Определение типов временных рядов для удаления.
get	TypesRequestBatchGetOrDelete	Определение возвращаемых типов временных рядов.
put	TimeSeriesType[]	Определение типов временных рядов для обновления или создания.

Ответы

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

Имя

Тип

Описание

200 OK

TypesBatchResponse

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

Заголовки

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	олицетворения учетной записи пользователя

Примеры

TypesBatchDeleteByIds

TypesBatchDeleteByNames

TypesBatchGetByIds

TypesBatchGetByNames

TypesBatchPut

TypesBatchDeleteByIds

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

HTTP

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

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

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

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

{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

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

HTTP

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

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

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

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

{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

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

HTTP

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

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

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

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

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

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

HTTP

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

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

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

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

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

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

HTTP

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

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

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

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

{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

Определения

Имя	Описание
AggregateVariable	Агрегатная переменная представляет любые вычисления агрегирования. Агрегатные переменные не поддерживают интерполяцию.
Boundary	Диапазон времени слева и справа от диапазона поиска, используемый для интерполяции. Это полезно в сценариях, когда точки данных отсутствуют близко к началу или концу диапазона входного поиска. Может иметь значение NULL.
CategoricalVariable	Категориальная переменная представляет сигнал, который необходимо проанализировать на основе количества или длительности возникновения ограниченного набора определенных значений.
Interpolation	Операция интерполяции для необработанных точек данных. В настоящее время допускается только выборка интерполированных временных рядов. Разрешенная агрегатная функция: слева($value). Может иметь значение NULL, если интерполяция не должна быть применена.
InterpolationKind	Тип метода интерполяции: "Линейная" или "Шаг".
NumericVariable	Числовая переменная представляет собой один непрерывный числовый сигнал, который можно восстановить с помощью интерполяции.
TimeSeriesAggregateCategory	Категория, используемая в категориальных переменных. Категория определяется меткой и значениями, назначенными этой меткой.
TimeSeriesDefaultCategory	Представляет категорию по умолчанию.
TimeSeriesType	Тип временных рядов определяет переменные или формулы для вычисления событий, связанных с экземплярами временных рядов. Каждый экземпляр временных рядов связан с точно одним типом. Тип может иметь одну или несколько переменных. Например, экземпляр временных рядов может иметь тип датчика температуры, который состоит из переменных среднее значение температуры, минимальной температуры и максимальной температуры.
TimeSeriesTypeOrError	Результат пакетной операции с определенным типом временных рядов. Объект type устанавливается, если операция выполнена успешно, и объект ошибки устанавливается при неудачной операции.
TsiError	Сведения об ошибке API.
TsiErrorBody	Определенная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.
Tsx	Выражение временных рядов (TSX), написанное как одна строка. Примеры: "$event. Status.String='Good', "avg($event. Температура)". См. документацию по написанию выражений временных рядов.
TypesBatchRequest	Запрос на выполнение одной операции в пакете типов временных рядов. Необходимо задать именно один из "get", "put" или "delete".
TypesBatchResponse	Ответ одной операции в пакете типов временных рядов. Будет задано значение "get", "put" или "delete".
TypesRequestBatchGetOrDelete	Запрос на получение или удаление типов временных рядов по идентификаторам или именам типов. Необходимо задать именно один из "typeIds" или "name".

AggregateVariable

Object

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

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

Boundary

Object

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

Имя	Тип	Описание
span	string (duration)

CategoricalVariable

Object

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

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

Interpolation

Object

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

Имя	Тип	Описание
boundary	Boundary	Диапазон времени слева и справа от диапазона поиска, используемый для интерполяции. Это полезно в сценариях, когда точки данных отсутствуют близко к началу или концу диапазона входного поиска. Может иметь значение NULL.
kind	InterpolationKind	Тип метода интерполяции: "Линейная" или "Шаг".

InterpolationKind

Перечисление

Тип метода интерполяции: "Линейная" или "Шаг".

Значение	Описание
Linear
Step

NumericVariable

Object

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

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

TimeSeriesAggregateCategory

Object

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

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

TimeSeriesDefaultCategory

Object

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

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

TimeSeriesType

Object

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

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

TimeSeriesTypeOrError

Object

Результат пакетной операции с определенным типом временных рядов. Объект type устанавливается, если операция выполнена успешно, и объект ошибки устанавливается при неудачной операции.

Имя	Тип	Описание
error	TsiErrorBody	Объект ошибки — установка при неудачной операции.
timeSeriesType	TimeSeriesType	Объект типа временных рядов — задает, когда операция выполнена успешно.

TsiError

Object

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

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

TsiErrorBody

Object

Определенная ошибка API с кодом ошибки и сообщением.

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

TsiErrorDetails

Object

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

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

Tsx

Object

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

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

TypesBatchRequest

Object

Запрос на выполнение одной операции в пакете типов временных рядов. Необходимо задать именно один из "get", "put" или "delete".

Имя	Тип	Описание
delete	TypesRequestBatchGetOrDelete	Определение типов временных рядов для удаления.
get	TypesRequestBatchGetOrDelete	Определение возвращаемых типов временных рядов.
put	TimeSeriesType[]	Определение типов временных рядов для обновления или создания.

TypesBatchResponse

Object

Ответ одной операции в пакете типов временных рядов. Будет задано значение "get", "put" или "delete".

Имя	Тип	Описание
delete	TsiErrorBody[]	Список объектов ошибок, соответствующих по позиции в массиве delete в запросе, — null, если операция выполнена успешно.
get	TimeSeriesTypeOrError[]	Список типов или объектов ошибок, соответствующих по позиции в массиве get в запросе. Объект type устанавливается, если операция выполнена успешно, и объект ошибки устанавливается при неудачной операции.
put	TimeSeriesTypeOrError[]	Список типов или объектов ошибок, соответствующих по позиции массива put в запросе. Объект type устанавливается, если операция выполнена успешно, и объект ошибки устанавливается при неудачной операции.

TypesRequestBatchGetOrDelete

Object

Запрос на получение или удаление типов временных рядов по идентификаторам или именам типов. Необходимо задать именно один из "typeIds" или "name".

Имя	Тип	Описание
names	string[]	Список имен типов временных рядов для возврата или удаления.
typeIds	string[]	Список идентификаторов типов временных рядов для возврата или удаления.

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

Time Series Types - Execute Batch

Параметры URI

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

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

Ответы

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

azure_auth

Области

Примеры

TypesBatchDeleteByIds

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

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

TypesBatchDeleteByNames

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

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

TypesBatchGetByIds

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

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

TypesBatchGetByNames

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

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

TypesBatchPut

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

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

Определения

AggregateVariable

Boundary

CategoricalVariable

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TimeSeriesTypeOrError

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

TypesBatchRequest

TypesBatchResponse

TypesRequestBatchGetOrDelete

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