你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	每个环境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。可以从 Get Environments API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version	query	True	string	要用于客户端请求的 API 的版本。当前支持的版本为“2020-07-31”。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string	可选的客户端请求 ID。服务记录此值。允许服务跨服务跟踪作，并允许客户联系有关特定请求的支持人员。
x-ms-client-session-id		string	可选的客户端会话 ID。服务记录此值。允许服务跨服务跟踪一组相关作，并允许客户联系有关特定请求组的支持人员。

请求正文

名称	类型	说明
delete	InstancesRequestBatchGetOrDelete	要删除的时序实例。可以指定时序 ID 或名称。
get	InstancesRequestBatchGetOrDelete	要返回的时序 ID 或时序实例的名称。
put	TimeSeriesInstance[]	要创建或更新的时间序列实例。
update	TimeSeriesInstance[]	要更新的时间序列实例。如果实例不存在，则返回错误。

响应

名称	类型	说明
200 OK	InstancesBatchResponse	操作成功。标头 x-ms-request-id: string
Other Status Codes	TsiError	意外错误。标头 x-ms-request-id: string

名称

类型

说明

200 OK

InstancesBatchResponse

操作成功。

标头

x-ms-request-id: string

Other Status Codes

TsiError

意外错误。

标头

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

示例请求

HTTP

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

示例请求

HTTP

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

示例请求

HTTP

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

示例请求

HTTP

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

示例请求

HTTP

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

示例请求

HTTP

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	对特定时序实例进行批处理作的结果。作成功时设置实例对象（放置作除外），作不成功时设置错误对象。
InstancesBatchRequest	请求对一批实例执行单个作。必须设置“get”、“put”、“update”或“delete”中的一个。
InstancesBatchResponse	对一批实例的单个作的响应。根据请求，只设置“get”、“put”、“update”或“delete”中的一个。
InstancesRequestBatchGetOrDelete	请求按时序 ID 或时序名称获取或删除实例。必须设置“timeSeriesIds”或“names”中的一个。
TimeSeriesInstance	时序实例是时序本身。在大多数情况下，deviceId 或 assetId 是环境中资产的唯一标识符。实例具有与之关联的描述性信息，称为实例字段。实例字段至少包含层次结构信息。它们还可以包括有用的描述性数据，例如制造商、运营商或最后服务日期。
TsiError	有关 API 错误的信息。
TsiErrorBody	具有错误代码和消息的特定 API 错误。
TsiErrorDetails	其他错误信息。

InstanceOrError

Object

对特定时序实例进行批处理作的结果。作成功时设置实例对象（放置作除外），作不成功时设置错误对象。

名称	类型	说明
error	TsiErrorBody	错误对象 - 在操作失败时设置。
instance	TimeSeriesInstance	时间序列实例对象 - 在作成功时设置（放置作除外）。

InstancesBatchRequest

Object

请求对一批实例执行单个作。必须设置“get”、“put”、“update”或“delete”中的一个。

名称	类型	说明
delete	InstancesRequestBatchGetOrDelete	要删除的时序实例。可以指定时序 ID 或名称。
get	InstancesRequestBatchGetOrDelete	要返回的时序 ID 或时序实例的名称。
put	TimeSeriesInstance[]	要创建或更新的时间序列实例。
update	TimeSeriesInstance[]	要更新的时间序列实例。如果实例不存在，则返回错误。

InstancesBatchResponse

Object

对一批实例的单个作的响应。根据请求，只设置“get”、“put”、“update”或“delete”中的一个。

名称	类型	说明
delete	TsiErrorBody[]	按位置对应于请求中“delete”数组的错误对象列表。 Null 表示实例已被删除或不存在。当作不成功时（例如，当存在与此时间序列实例关联的事件时），将设置 Error 对象。
get	InstanceOrError[]	按位置对应于请求中“get”数组的实例或错误对象的列表。作成功时设置实例对象，作不成功时设置错误对象。
put	InstanceOrError[]	按位置对应于请求中“put”数组的错误对象列表。作不成功时设置错误对象。
update	InstanceOrError[]	按位置对应于请求中“update”数组的错误对象列表。作成功时设置实例对象，作不成功时设置错误对象。

InstancesRequestBatchGetOrDelete

Object

请求按时序 ID 或时序名称获取或删除实例。必须设置“timeSeriesIds”或“names”中的一个。

名称	类型	说明
names	string[]	要返回或删除的时间序列实例的名称列表。
timeSeriesIds	TimeSeriesId[]	要返回或删除的时序实例的时序 ID 列表。