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 參數

名稱	位於	必要	類型	Description
environmentFqdn	path	True	string	每個環境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。您可以從取得環境 API、Azure 入口網站或 Azure Resource Manager 的回應取得此功能變數名稱。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前支援的版本是「2020-07-31」。
storeType	query		string	針對已啟用暖存放區的環境，可以在 'WarmStore' 或 'ColdStore' 上執行查詢。查詢中的此參數會定義查詢應該在哪個目標存放區執行。如果未定義，查詢將會在冷存放區上執行。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string	選擇性用戶端要求識別碼。服務會記錄此值。允許服務追蹤服務之間的作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id		string	選擇性用戶端會話識別碼。服務會記錄此值。允許服務追蹤跨服務的相關作業群組，並允許客戶連絡有關特定要求群組的支持人員。

要求本文

名稱	必要	類型	Description
searchSpan	True	DateTimeRange	執行查詢的時間範圍。不可為空值。

回應

名稱	類型	Description
200 OK	EventSchema	作業成功。標題 x-ms-request-id: string
Other Status Codes	TsiError	未預期的錯誤。標題 x-ms-request-id: string

名稱

類型

Description

200 OK

EventSchema

作業成功。

標題

x-ms-request-id: string

Other Status Codes

TsiError

未預期的錯誤。

標題

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
DateTimeRange	時間範圍。不可以是 Null 或負數。
EventProperty	已儲存或計算之事件的屬性。屬性會透過名稱和類型來識別。不同的事件可以有具有相同名稱的屬性，但類型不同。
EventSchema	指定搜尋範圍內所有事件的事件架構。事件架構是一組屬性定義。屬性會透過名稱和類型來識別。不同的事件可以有具有相同名稱的屬性，但類型不同。當屬性太多時，事件架構可能不會包含所有保存的屬性。
GetEventSchemaRequest	要求取得指定搜尋範圍內所有事件的事件架構。
PropertyTypes	屬性的類型。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。

DateTimeRange

Object

時間範圍。不可以是 Null 或負數。

名稱	類型	Description
from	string (date-time)	時間範圍的開始時間戳。在時間序列查詢要求中使用時間戳時，會包含時間戳。包含具有此時間戳的事件。
to	string (date-time)	時間範圍的結束時間戳。在時間序列查詢要求中使用結束時間戳是獨佔的。排除符合此時間戳的事件。請注意，Get Availability 傳回的結尾時間戳是內含的（這表示有具有此確切「到」時間戳的事件）。

EventProperty

Object

已儲存或計算之事件的屬性。屬性會透過名稱和類型來識別。不同的事件可以有具有相同名稱的屬性，但類型不同。

名稱	類型	Description
name	string	屬性的名稱。
type	PropertyTypes	屬性的類型。

EventSchema

Object

指定搜尋範圍內所有事件的事件架構。事件架構是一組屬性定義。屬性會透過名稱和類型來識別。不同的事件可以有具有相同名稱的屬性，但類型不同。當屬性太多時，事件架構可能不會包含所有保存的屬性。

名稱	類型	Description
properties	EventProperty[]	一組屬性定義。當環境沒有數據時，傳回的陣列是空的。

GetEventSchemaRequest

Object

要求取得指定搜尋範圍內所有事件的事件架構。

名稱	類型	Description
searchSpan	DateTimeRange	執行查詢的時間範圍。不可為空值。

PropertyTypes

列舉型別

屬性的類型。

值	Description
Bool
DateTime
Double
String
TimeSpan
Long

TsiError

Object

API 錯誤的相關信息。

名稱	類型	Description
error	TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。

TsiErrorBody

Object

具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。可用來以程式設計方式處理特定錯誤案例。
details	TsiErrorDetails[]	包含其他錯誤資訊。可能是 Null。
innerError	TsiErrorBody	包含更具體的錯誤，可縮小原因。可能是 Null。
message	string	人類可讀且與語言無關的錯誤表示法。其用途是開發人員的協助，不適合接觸終端使用者。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。可能是 Null。

TsiErrorDetails

Object

其他錯誤資訊。

名稱	類型	Description
code	string	語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。可用來以程式設計方式處理特定錯誤案例。
message	string	人類可讀且與語言無關的錯誤表示法。其用途是開發人員的協助，不適合接觸終端使用者。

共用方式為

Query - Get Event Schema

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

範例

ColdStoreEventSchemaGet

範例要求

範例回覆

EventSchemaGet

範例要求

範例回覆

EventSchemaGetEmpty

範例要求

範例回覆

WarmStoreEventSchemaGet

範例要求

範例回覆

定義

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails