Time Series Types - List

參考

Service:: Time Series Insights

API Version:: 2020-07-31

取得頁面中的時間序列類型。

GET https://{environmentFqdn}/timeseries/types?api-version=2020-07-31

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」。

要求標頭

名稱	類型	Description
x-ms-continuation	string	來自上一頁結果的接續令牌，以擷取支援分頁之呼叫中結果的下一頁。若要取得第一頁結果，請將 Null 接續令牌指定為參數值。如果已傳回所有結果，則傳回的接續標記為 Null，而且沒有下一頁的結果。
x-ms-client-request-id	string	選擇性用戶端要求識別碼。服務會記錄此值。允許服務跨服務追蹤作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id	string	選擇性用戶端會話識別碼。服務會記錄此值。允許服務追蹤跨服務的相關作業群組，並允許客戶連絡支持人員，以取得特定要求群組的相關信息。

回應

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

名稱

類型

Description

200 OK

GetTypesPage

成功的作業。

Headers

x-ms-request-id: string

Other Status Codes

TsiError

非預期的錯誤。

Headers

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

TypesListPage1

TypesListPage2

TypesListPage3

TypesListPage1

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

TypesListPage2

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": [
    {
      "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "TurbineSensor",
      "description": "Wind turbine sensor",
      "variables": {
        "Value": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.value.Double"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

TypesListPage3

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "types": []
}

定義

名稱	Description
AggregateVariable	匯總變數代表任何匯總計算。匯總變數不支援插補。
Boundary	要用於插補的搜尋範圍左邊和右邊的時間範圍。這在接近輸入搜尋範圍的開始或結尾處遺失數據點的情況下很有説明。可以是 null。
CategoricalVariable	類別變數代表必須根據發生一組有限定義值的計數或持續時間進行分析的訊號。
GetTypesPage	單一要求中傳回的時間序列類型部分清單。
Interpolation	要對原始數據點執行的插補作業。目前只允許取樣插補的時間序列。允許的聚合函數 - 例如：左 ($value) 。如果不需要套用插補點，則可以為 Null。
InterpolationKind	插補技術的類型：「Linear」或「Step」。。
NumericVariable	數值變數代表單一連續數值訊號，可使用插補重新建構。
TimeSeriesAggregateCategory	類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。
TimeSeriesDefaultCategory	表示預設類別。
TimeSeriesType	時間序列類型會定義變數或公式，以針對與時間序列實例相關聯的事件執行計算。每個時間序列實例都只與一個類型相關聯。一個類型可以有一或多個變數。例如，時間序列實例的類型可能是 Temperature Sensor，其中包含平均溫度、最小溫度和溫度上限變數。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。
Tsx	時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'“， ”avg ($event.溫度) “。請參閱有關如何撰寫時間序列表達式的檔。

AggregateVariable

匯總變數代表任何匯總計算。匯總變數不支援插補。

名稱	類型	Description
aggregation	Tsx	當種類為「匯總」時，匯總時間序列表達式是用來表示需要直接使用「$event」等事件屬性執行的匯總。溫度」。例如，計算溫度變更範圍的匯總可以寫入為：「最大 ($event。溫度) 分鐘 ($event。溫度) 」。
filter	Tsx	篩選限制要考慮計算之事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
kind	string: aggregate	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「數值」可讓您指定重建訊號的值，以及匯總它們的運算式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。

Boundary

要用於插補的搜尋範圍左邊和右邊的時間範圍。這在接近輸入搜尋範圍的開始或結尾處遺失數據點的情況下很有説明。可以是 null。

名稱	類型	Description
span	string

CategoricalVariable

類別變數代表必須根據發生一組有限定義值的計數或持續時間進行分析的訊號。

名稱	類型	Description
categories	TimeSeriesAggregateCategory[]	類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。
defaultCategory	TimeSeriesDefaultCategory	表示預設類別。
filter	Tsx	篩選限制要考慮計算之事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
interpolation	Interpolation	類別變數只支援『step』插補。
kind	string: categorical	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「數值」可讓您指定重建訊號的值，以及匯總它們的運算式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。
value	Tsx	值時間序列表達式是用來表示要分類之訊號的值。它只能評估為類別變數的『String』或 'Long' 類型。

GetTypesPage

單一要求中傳回的時間序列類型部分清單。

名稱	類型	Description
continuationToken	string	如果傳回，這表示目前的結果代表部分結果。接續令牌允許取得下一頁的結果。若要取得查詢結果的下一頁，請在「x-ms-continuation」 HTTP 標頭中使用接續令牌參數傳送相同的要求。
types	TimeSeriesType[]	單一要求中傳回的時間序列類型部分清單。如果伺服器無法在此要求中以更多類型填滿頁面，或接續令牌為 Null 時沒有其他類型，則可為空白。

Interpolation

要對原始數據點執行的插補作業。目前只允許取樣插補的時間序列。允許的聚合函數 - 例如：左 ($value) 。如果不需要套用插補點，則可以為 Null。

名稱	類型	Description
boundary	Boundary	要用於插補的搜尋範圍左邊和右邊的時間範圍。這在接近輸入搜尋範圍的開始或結尾處遺失數據點的情況下很有説明。可以是 null。
kind	InterpolationKind	插補技術的類型：「Linear」或「Step」。。

InterpolationKind

插補技術的類型：「Linear」或「Step」。。

名稱	類型	Description
Linear	string
Step	string

NumericVariable

數值變數代表單一連續數值訊號，可使用插補重新建構。

名稱	類型	Description
aggregation	Tsx	當種類為「numeric」時，匯總時間序列表達式用來表示必須在$value運算式上執行的匯總。這需要指定$value，而且只能在聚合函數內使用$value。例如，計算最小$value的匯總會寫入為：「最小 ($value) 」。
filter	Tsx	篩選限制要考慮計算之事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
interpolation	Interpolation	要對原始數據點執行的插補作業。目前只允許取樣插補的時間序列。允許的聚合函數 - 例如：左 ($value) 。如果不需要套用插補點，則可以為 Null。
kind	string: numeric	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「數值」可讓您指定重建訊號的值，以及匯總它們的運算式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。
value	Tsx	值時間序列表達式是用來表示即將匯總或插補的訊號值。例如，事件的溫度值會像這樣表示：「$event。Temperature.Double”。

TimeSeriesAggregateCategory

類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。

名稱	類型	Description
label	string	用來建構輸出變數名稱的類別名稱。
values	object[]	類別目錄所對應的值清單。可以是字串的唯一清單或long清單。

TimeSeriesDefaultCategory

表示預設類別。

名稱	類型	Description
label	string	將指派給不符合『categories』中定義之任何值的預設類別名稱。

TimeSeriesType

時間序列類型會定義變數或公式，以針對與時間序列實例相關聯的事件執行計算。每個時間序列實例都只與一個類型相關聯。一個類型可以有一或多個變數。例如，時間序列實例的類型可能是 Temperature Sensor，其中包含平均溫度、最小溫度和溫度上限變數。

名稱	類型	Description
description	string	類型的描述。可能是 Null。
id	string	不可變的區分大小寫的唯一類型標識碼。在建立或更新要求時可為 Null，然後伺服器會產生標識碼。取得和刪除作業時不是 Null。
name	string	使用者指定之類型的唯一名稱。可變動，而非 Null。
variables	object	與型別相關聯的不同變數。不是空的，不是 Null。

TsiError

API 錯誤的相關信息。

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

TsiErrorBody

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

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

TsiErrorDetails

其他錯誤資訊。

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

Tsx

時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'“， ”avg ($event.溫度) “。請參閱有關如何撰寫時間序列表達式的檔。

名稱	類型	Description
tsx	string	時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'“， ”avg ($event.溫度) “。請參閱有關如何撰寫時間序列表達式的檔。

共用方式為

Time Series Types - List

URI 參數

要求標頭

回應

安全性

azure_auth

Scopes

範例

TypesListPage1

Sample Request

Sample Response

TypesListPage2

Sample Request

Sample Response

TypesListPage3

Sample Request

Sample Response

定義

AggregateVariable

Boundary

CategoricalVariable

GetTypesPage

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

其他資源