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

Query - Get Event Schema

服务:: Time Series Insights

API 版本:: 2020-07-31

返回给定搜索范围的环境事件架构。事件架构是一组属性定义。当属性过多时，事件架构可能不包含所有持久化属性。

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

具有可选参数:

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

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”。
storeType	query		string	对于启用了暖存储的环境，可以在“WarmStore”或“ColdStore”上执行查询。查询中的此参数定义应在哪个商店执行查询。如果未定义，查询将在冷存储上执行。

请求头

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

请求正文

名称	必需	类型	说明
searchSpan	True	DateTimeRange	执行查询的时间范围。不能为 null。

响应

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

名称

类型

说明

200 OK

EventSchema

作成功。

标头

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

示例

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

示例请求

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

示例响应

状态代码:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGet

示例请求

HTTP

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

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

示例响应

状态代码:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGetEmpty

示例请求

HTTP

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

{
  "searchSpan": {
    "from": "2016-08-01T00:00:00.000Z",
    "to": "2016-08-31T00:00:00.000Z"
  }
}

示例响应

状态代码:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

示例请求

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

示例响应

状态代码:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

定义

名称	说明
DateTimeRange	时间范围。不能为 null 或负值。
EventProperty	存储或计算的事件的属性。属性由名称和类型标识。不同的事件可以具有具有相同名称但类型不同的属性。
EventSchema	给定搜索范围内所有事件的事件架构。事件架构是一组属性定义。属性由名称和类型标识。不同的事件可以具有具有相同名称但类型不同的属性。当属性过多时，事件架构可能不包含所有持久化属性。
GetEventSchemaRequest	请求获取给定搜索范围内所有事件的事件架构。
PropertyTypes	属性的类型。
TsiError	有关 API 错误的信息。
TsiErrorBody	具有错误代码和消息的特定 API 错误。
TsiErrorDetails	其他错误信息。

DateTimeRange

Object

时间范围。不能为 null 或负值。

名称	类型	说明
from	string (date-time)	时间范围的开始时间戳。在时序查询请求中使用开始时间戳是非独占的。包含此时间戳的事件。
to	string (date-time)	时间范围的结束时间戳。在时序查询请求中使用结束时间戳是独占的。排除与此时间戳匹配的事件。请注意，Get Availability 返回时结束时间戳是非独占的（这意味着存在具有此确切“to”时间戳的事件）。

EventProperty

Object

存储或计算的事件的属性。属性由名称和类型标识。不同的事件可以具有具有相同名称但类型不同的属性。

名称	类型	说明
name	string	属性的名称。
type	PropertyTypes	属性的类型。

EventSchema

Object

给定搜索范围内所有事件的事件架构。事件架构是一组属性定义。属性由名称和类型标识。不同的事件可以具有具有相同名称但类型不同的属性。当属性过多时，事件架构可能不包含所有持久化属性。

名称	类型	说明
properties	EventProperty[]	一组属性定义。当环境没有数据时，返回的数组为空。

GetEventSchemaRequest

Object

请求获取给定搜索范围内所有事件的事件架构。

名称	类型	说明
searchSpan	DateTimeRange	执行查询的时间范围。不能为 null。

PropertyTypes

枚举

属性的类型。

值	说明
Bool
DateTime
Double
String
TimeSpan
Long

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

通过

Query - Get Event Schema

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

ColdStoreEventSchemaGet

示例请求

示例响应

EventSchemaGet

示例请求

示例响应

EventSchemaGetEmpty

示例请求

示例响应

WarmStoreEventSchemaGet

示例请求

示例响应

定义

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails