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

Query - Get Event Schema

参考

Service:: Time Series Insights

API Version:: 2020-07-31

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

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

With optional parameters:

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。可以从获取环境 API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前支持的版本为“2020-07-31”。
storeType	query		string	对于启用了暖存储的环境，可以在“WarmStore”或“ColdStore”上执行查询。查询中的此参数定义应对哪个存储执行查询。如果未定义，将对 Cold 存储区执行查询。

请求头

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

请求正文

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

响应

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

名称

类型

说明

200 OK

EventSchema

成功的操作。

Headers

x-ms-request-id: string

Other Status Codes

TsiError

意外错误。

Headers

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Sample Request

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"
  }
}

Sample Response

Status code:: 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

Sample Request

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"
  }
}

Sample Response

Status code:: 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

Sample Request

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"
  }
}

Sample Response

Status code:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Sample Request

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"
  }
}

Sample Response

Status code:: 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

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

名称	类型	说明
from	string	时间范围的开始时间戳。在时序查询请求中使用时，起始时间戳是非独占的。包含此时间戳的事件。
to	string	时间范围的结束时间戳。在时序查询请求中使用时，结束时间戳是独占的。排除与此时间戳匹配的事件。请注意，当获取可用性 (返回时，结束时间戳是包含的，这意味着) 具有此确切的“到”时间戳的事件。

EventProperty

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

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

EventSchema

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

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

GetEventSchemaRequest

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

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

PropertyTypes

属性的类型。

名称	类型	说明
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

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

Query - Get Event Schema

URI 参数

请求头

请求正文

响应

安全性

azure_auth

Scopes

示例

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

定义

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

其他资源