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

Time Series Hierarchies - Execute Batch

服务:: Time Series Insights

API 版本:: 2020-07-31

对多个时序层次结构定义执行批量获取、创建、更新、删除作。

POST https://{environmentFqdn}/timeseries/hierarchies/$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	HierarchiesRequestBatchGetDelete	在通过 ID 或名称获取特定层次结构时应设置“delete”。
get	HierarchiesRequestBatchGetDelete	在通过 ID 或名称获取特定层次结构时应设置“get”。
put	TimeSeriesHierarchy[]	在创建或更新层次结构时应设置“put”。

响应

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

名称

类型

说明

200 OK

HierarchiesBatchResponse

操作成功。

标头

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	模拟用户帐户

示例

HierarchiesBatchDeleteByIds

HierarchiesBatchDeleteByNames

HierarchiesBatchGetByIds

HierarchiesBatchGetByNames

HierarchiesBatchPut

HierarchiesBatchDeleteByIds

示例请求

HTTP

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

{
  "delete": {
    "hierarchyIds": [
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

示例响应

状态代码:: 200

{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

示例请求

HTTP

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

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

示例响应

状态代码:: 200

{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

示例请求

HTTP

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

{
  "get": {
    "hierarchyIds": [
      "6e292e54-9a26-4be1-9034-607d71492707",
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

示例响应

状态代码:: 200

{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchGetByNames

示例请求

HTTP

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

{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

示例响应

状态代码:: 200

{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchPut

示例请求

HTTP

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

{
  "put": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    },
    {
      "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
      "name": "ManufactureDate",
      "source": {
        "instanceFieldNames": [
          "year",
          "month"
        ]
      }
    }
  ]
}

示例响应

状态代码:: 200

{
  "put": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      },
      "error": null
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      },
      "error": null
    }
  ]
}

定义

名称	说明
HierarchiesBatchRequest	请求对一批层次结构执行单个作。必须设置“get”、“put”或“delete”之一。
HierarchiesBatchResponse	对一批时间序列层次结构的单个作的响应。仅设置“get”、“put”或“delete”之一。
HierarchiesRequestBatchGetDelete	请求获取或删除多个时序层次结构。必须设置“hierarchyIds”或“names”中的一个。
Source	定义如何创建时序层次结构树级别。
TimeSeriesHierarchy	时序层次结构将时序实例组织到树中。
TimeSeriesHierarchyOrError	对特定时间序列层次结构进行批处理作的结果。作成功时设置层次结构，作不成功时设置错误对象。
TsiError	有关 API 错误的信息。
TsiErrorBody	具有错误代码和消息的特定 API 错误。
TsiErrorDetails	其他错误信息。

HierarchiesBatchRequest

Object

请求对一批层次结构执行单个作。必须设置“get”、“put”或“delete”之一。

名称	类型	说明
delete	HierarchiesRequestBatchGetDelete	在通过 ID 或名称获取特定层次结构时应设置“delete”。
get	HierarchiesRequestBatchGetDelete	在通过 ID 或名称获取特定层次结构时应设置“get”。
put	TimeSeriesHierarchy[]	在创建或更新层次结构时应设置“put”。

HierarchiesBatchResponse

Object

对一批时间序列层次结构的单个作的响应。仅设置“get”、“put”或“delete”之一。

名称	类型	说明
delete	TsiErrorBody[]	请求中“delete”数组对应的错误对象列表 - 操作成功时为 null。
get	TimeSeriesHierarchyOrError[]	按位置对应于请求中“get”数组的层次结构或错误对象的列表。作成功时设置层次结构对象，作失败时设置错误对象。
put	TimeSeriesHierarchyOrError[]	按位置对应于请求中“put”数组的层次结构或错误对象的列表。作成功时设置层次结构对象，作失败时设置错误对象。

HierarchiesRequestBatchGetDelete

Object

请求获取或删除多个时序层次结构。必须设置“hierarchyIds”或“names”中的一个。

名称	类型	说明
hierarchyIds	string[]	层次结构 ID 列表。
names	string[]	层次结构名称列表。

Source

Object

定义如何创建时序层次结构树级别。

名称	类型	说明
instanceFieldNames	string[]	必须在属于此层次结构的所有时序实例中设置的实例字段名称列表。实例字段的顺序定义了层次结构中的级别。

TimeSeriesHierarchy

Object

时序层次结构将时序实例组织到树中。

名称	类型	说明
id	string	区分大小写的唯一层次结构标识符。在创建层次结构对象时可以为 null，然后服务器在获取和删除作时生成 id，而不是 null。
name	string	用户为类型提供的唯一名称。它是可变的，不是空的。
source	Source	定义如何创建时序层次结构树级别。

TimeSeriesHierarchyOrError

Object

对特定时间序列层次结构进行批处理作的结果。作成功时设置层次结构，作不成功时设置错误对象。

名称	类型	说明
error	TsiErrorBody	错误对象 - 在操作失败时设置。
hierarchy	TimeSeriesHierarchy	时序层次结构对象 - 在作成功时设置。

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	人为可读的、与语言无关的错误表示形式。它旨在帮助开发人员，不适合向最终用户公开。

通过

Time Series Hierarchies - Execute Batch

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

HierarchiesBatchDeleteByIds

示例请求

示例响应

HierarchiesBatchDeleteByNames

示例请求

示例响应

HierarchiesBatchGetByIds

示例请求

示例响应

HierarchiesBatchGetByNames

示例请求

示例响应

HierarchiesBatchPut

示例请求

示例响应

定义

HierarchiesBatchRequest

HierarchiesBatchResponse

HierarchiesRequestBatchGetDelete

Source

TimeSeriesHierarchy

TimeSeriesHierarchyOrError

TsiError

TsiErrorBody

TsiErrorDetails