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

Time Series Instances - Execute Batch

  • Ссылка
Служба:
Time Series Insights
Версия API:
2020-07-31

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

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

Параметры 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.

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

Имя Обязательно Тип Описание
x-ms-client-request-id

string

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

string

Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группы связанных операций в службах и позволяет клиенту обращаться в службу поддержки по поводу определенной группы запросов.

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

Имя Тип Описание
delete

InstancesRequestBatchGetOrDelete

Удаляемые экземпляры временных рядов. Можно указать идентификатор или имя временного ряда.
get

InstancesRequestBatchGetOrDelete

Идентификаторы временных рядов или имена возвращаемых экземпляров временных рядов.
put

TimeSeriesInstance[]

Создаваемые или обновляемые экземпляры временных рядов.
update

TimeSeriesInstance[]

Обновляемый экземпляр временных рядов. Если экземпляр не существует, возвращается ошибка.

Ответы

Имя Тип Описание
200 OK

InstancesBatchResponse

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

Заголовки

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

Примеры

InstancesBatchDeleteByIds
InstancesBatchDeleteByNames
InstancesBatchGetByIds
InstancesBatchGetByNames
InstancesBatchPut
InstancesBatchUpdate

InstancesBatchDeleteByIds

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

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

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

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

Код состояния:
200 
{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

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

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

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

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

Код состояния:
200 
{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

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

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

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

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

Код состояния:
200 
{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

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

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

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

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

Код состояния:
200 
{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

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

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

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

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

Код состояния:
200 
{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

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

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

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

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

Код состояния:
200 
{
  "update": [
    {
      "error": null
    }
  ]
}

Определения

Имя Описание
InstanceOrError

Результат пакетной операции для определенного экземпляра временного ряда. Объект экземпляра задается при успешном выполнении операции (за исключением операции put), а объект ошибки — при неудачной операции.
InstancesBatchRequest

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

Ответ одной операции с пакетом экземпляров. На основе запроса будет задан только один из значений "get", "put", "update" или "delete".
InstancesRequestBatchGetOrDelete

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

Экземпляры временных рядов — это сами временные ряды. В большинстве случаев они представляют собой DeviceID или AssetID — уникальный идентификатор ресурса в среде. С экземплярами связана описательная информация, называемая полями экземпляров. Как минимум поля экземпляра содержат сведения об иерархии. Они также могут содержать полезные, описательные данные, например сведения о производителе, операторе или дату последнего обновления.
TsiError

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

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

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

InstanceOrError

Результат пакетной операции для определенного экземпляра временного ряда. Объект экземпляра задается при успешном выполнении операции (за исключением операции put), а объект ошибки — при неудачной операции.

Имя Тип Описание
error

TsiErrorBody

Объект ошибки — устанавливается при неудачном выполнении операции.
instance

TimeSeriesInstance

Объект экземпляра временного ряда — устанавливается при успешном выполнении операции (за исключением операции put).

InstancesBatchRequest

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

Имя Тип Описание
delete

InstancesRequestBatchGetOrDelete

Удаляемые экземпляры временных рядов. Можно указать идентификатор или имя временного ряда.
get

InstancesRequestBatchGetOrDelete

Идентификаторы временных рядов или имена возвращаемых экземпляров временных рядов.
put

TimeSeriesInstance[]

Создаваемые или обновляемые экземпляры временных рядов.
update

TimeSeriesInstance[]

Обновляемый экземпляр временных рядов. Если экземпляр не существует, возвращается ошибка.

InstancesBatchResponse

Ответ одной операции с пакетом экземпляров. На основе запроса будет задан только один из значений "get", "put", "update" или "delete".

Имя Тип Описание
delete

TsiErrorBody[]

Список объектов ошибок, соответствующих по позиции массиву delete в запросе. Значение NULL означает, что экземпляр был удален или не существует. Объект ошибки устанавливается при неудачной операции (например, при наличии событий, связанных с этим экземпляром временного ряда).
get

InstanceOrError[]

Список объектов экземпляров или ошибок, соответствующих по позиции массиву get в запросе. Объект экземпляра задается при успешном выполнении операции, а объект error — при неудачной операции.
put

InstanceOrError[]

Список объектов ошибок, соответствующих по позиции массиву put в запросе. Объект ошибки задается при неудачной операции.
update

InstanceOrError[]

Список объектов ошибок, соответствующих по позиции массиву update в запросе. Объект экземпляра задается при успешном выполнении операции, а объект error — при неудачной операции.

InstancesRequestBatchGetOrDelete

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

Имя Тип Описание
names

string[]

Список имен экземпляров временных рядов для возврата или удаления.
timeSeriesIds

TimeSeriesId[]

Список идентификаторов временных рядов экземпляров временных рядов для возврата или удаления.

TimeSeriesInstance

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

Имя Тип Описание
description

string

Это необязательное поле содержит описание экземпляра .
hierarchyIds

string[]

Набор идентификаторов иерархии временных рядов, к которым принадлежит экземпляр. Может принимать значение NULL.
instanceFields

Набор пар "ключ-значение", содержащих определяемые пользователем свойства экземпляра. Значение может быть равно null. Поддерживаемые типы значений свойств: bool, string, long, double и не могут быть вложенными или null.
name

string

Необязательное имя экземпляра, уникального в среде. Имена выступают в качестве изменяемого псевдонима или отображаемого имени экземпляра временного ряда. Изменяемый, может иметь значение NULL.
timeSeriesId

TimeSeriesId[]

Идентификатор временного ряда, который однозначно идентифицирует экземпляр. Он соответствует свойствам идентификатора временного ряда в среде. Неизменяемый, никогда не имеет значения NULL.
typeId

string

Представляет тип, к которому принадлежит данный экземпляр. Никогда не равно NULL.

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

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