共用方式為

Time Series Instances - Search

  • 參考
服務:
Time Series Insights
API 版本:
2020-07-31

根據實例屬性搜尋時間序列實例的部分點擊清單。

POST https://{environmentFqdn}/timeseries/instances/search?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
searchString True

string

會比對時間序列實例屬性的查詢搜尋字串。 範例：「floor 100」。。 不區分大小寫，必須存在，但可以是空字串。
hierarchies

SearchInstancesHierarchiesParameters

如何傳回時間序列實例階層的參數。 如果為 null，則不會傳回階層。 如果 instances 參數為 null，且階層參數不是 null，則只會傳回沒有實例的階層。
instances

SearchInstancesParameters

如何傳回時間序列實例的參數。 可以是 null。 當實例和階層參數都是 Null 時，系統會根據參數的預設值在結果中傳回實例，而且不會傳回階層。
path

string[]

篩選時間序列實例的階層路徑。 Path 會表示為字串路徑區段的陣列。 第一個專案應該是階層名稱。 範例：[“Location”， “California”]。 選擇性、區分大小寫、永不空白且可為 Null。

回應

名稱 類型 Description
200 OK

SearchInstancesResponsePage

搜尋回應成功。

標題

x-ms-request-id: string
Other Status Codes

TsiError

非預期的錯誤。

標題

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

範圍

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

範例

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

範例要求

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

{
  "searchString": "floor 100"
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesExpandHierarchiesOnly

範例要求

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

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": null,
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage1

範例要求

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1Two",
            "Id2Two",
            "2.0"
          ],
          "typeName": "DefaultType",
          "name": "instance2",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "San Francisco"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Francisco",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage2

範例要求

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1One",
            "Id2One",
            "1.0"
          ],
          "typeName": "DefaultType",
          "name": "instance1",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "Los Angeles"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesHierarchiesDefaultInputPage3

範例要求

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

範例回覆

狀態碼:
200 
{
  "instances": null,
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Diego",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesOneLevel

範例要求

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "OneLevel"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

範例要求

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

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": null
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesUntilChildren

範例要求

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

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

範例回覆

狀態碼:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

定義

名稱 Description
HierarchiesExpandKind

階層節點的擴充種類。 當它設定為 『UntilChildren』 時，階層節點會以遞歸方式展開，直到有多個子系為止。 當它設定為 『OneLevel』 時，階層只會在單一層級比對路徑搜尋實例參數上展開。 選擇性，預設值為 'UntilChildren'。
HierarchiesExpandParameter

是否要在相同搜尋實例呼叫中展開階層節點的定義。
HierarchiesSortBy

用於階層節點排序的值。 當它設定為 『CumulativeInstanceCount』 時，傳回的階層會根據屬於階層節點及其子階層節點的實例總數來排序。 當它設定為 『Name』時，傳回的階層會根據階層名稱排序。 選擇性，預設值為 'CumulativeInstanceCount'。
HierarchiesSortParameter

階層節點排序的定義。
HierarchyHit

階層節點，其中包含根據輸入比對查詢的實例。 可以是空白或 Null。
Highlights

要向用戶顯示的時間序列實例反白顯示文字。 反白顯示符合搜尋字串之文字部分的插入和 標記。 請勿使用任何醒目提示的屬性來執行進一步的 API 呼叫。
InstanceHit

實例搜尋呼叫所傳回的時間序列實例。 傳回的實例會比對搜尋要求，且包含醒目提示的文字，如果設定為 『true』，則會向用戶顯示。
InstancesSortBy

值，用於在搜尋實例呼叫傳回之前排序時間序列實例。 當它設定為 『Rank』 時，傳回的實例會根據相關性來排序。 當它設定為 『DisplayName』 時，傳回的結果會根據顯示名稱排序。 如果實例存在，則顯示名稱是實例的名稱，否則顯示名稱會是時間序列標識元。 預設值為 『Rank』。
InstancesSortParameter

定義在搜尋實例呼叫傳回之前，時間序列實例的排序方式。
SearchHierarchyNodesResponse

階層節點，其中包含根據輸入比對查詢的實例。 可以是空白或 Null。
SearchInstancesHierarchiesParameters

如何透過搜尋實例呼叫傳回時間序列實例階層的參數。
SearchInstancesParameters

如何透過搜尋實例呼叫傳回時間序列實例的參數。
SearchInstancesRequest

要求對時間序列實例執行搜尋查詢，並傳回相符的時間序列實例。
SearchInstancesResponse

根據輸入比對查詢的實例。 可以是空白或 Null。
SearchInstancesResponsePage

搜尋結果的單一頁面。
TsiError

API 錯誤的相關信息。
TsiErrorBody

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

其他錯誤資訊。

HierarchiesExpandKind

階層節點的擴充種類。 當它設定為 『UntilChildren』 時，階層節點會以遞歸方式展開，直到有多個子系為止。 當它設定為 『OneLevel』 時，階層只會在單一層級比對路徑搜尋實例參數上展開。 選擇性，預設值為 'UntilChildren'。

名稱 類型 Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

是否要在相同搜尋實例呼叫中展開階層節點的定義。

名稱 類型 Description
kind

HierarchiesExpandKind

階層節點的擴充種類。 當它設定為 『UntilChildren』 時，階層節點會以遞歸方式展開，直到有多個子系為止。 當它設定為 『OneLevel』 時，階層只會在單一層級比對路徑搜尋實例參數上展開。 選擇性，預設值為 'UntilChildren'。

HierarchiesSortBy

用於階層節點排序的值。 當它設定為 『CumulativeInstanceCount』 時，傳回的階層會根據屬於階層節點及其子階層節點的實例總數來排序。 當它設定為 『Name』時，傳回的階層會根據階層名稱排序。 選擇性，預設值為 'CumulativeInstanceCount'。

名稱 類型 Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

階層節點排序的定義。

名稱 類型 Description
by

HierarchiesSortBy

用於階層節點排序的值。 當它設定為 『CumulativeInstanceCount』 時，傳回的階層會根據屬於階層節點及其子階層節點的實例總數來排序。 當它設定為 『Name』時，傳回的階層會根據階層名稱排序。 選擇性，預設值為 'CumulativeInstanceCount'。

HierarchyHit

階層節點，其中包含根據輸入比對查詢的實例。 可以是空白或 Null。

名稱 類型 Description
cumulativeInstanceCount

integer

屬於這個節點的實例總數，而且其子樹符合查詢。
hierarchyNodes

SearchHierarchyNodesResponse

這個節點的子階層節點。 可以是空白或 Null。
name

string

階層節點的名稱。 可能是空的，不能是 Null。

Highlights

要向用戶顯示的時間序列實例反白顯示文字。 反白顯示符合搜尋字串之文字部分的插入和 標記。 請勿使用任何醒目提示的屬性來執行進一步的 API 呼叫。

名稱 類型 Description
description

string

時間序列實例的反白顯示描述。 可能是 Null。
hierarchyIds

string[]

時間序列實例所屬的醒目提示時間序列階層標識符清單。 無法用來查閱階層。 可能是 Null。
hierarchyNames

string[]

時間序列實例所屬的醒目提示時間序列階層名稱清單。 無法用來查閱階層。 可能是 Null。
instanceFieldNames

string[]

反白顯示的時間序列實例域名清單。 可能是 Null。
instanceFieldValues

string[]

醒目提示的時間序列實例域值清單。 可能是 Null。
name

string

時間序列實例的反白顯示名稱。 可能是 Null。
timeSeriesId

string[]

用於顯示之時間序列識別碼的醒目提示字串值清單。 無法用來查閱實例。
typeName

string

反白顯示此實例所屬的時間序列類型名稱。

InstanceHit

實例搜尋呼叫所傳回的時間序列實例。 傳回的實例會比對搜尋要求，且包含醒目提示的文字，如果設定為 『true』，則會向用戶顯示。

名稱 類型 Description
hierarchyIds

string[]

符合搜尋要求所屬時間序列實例的時間序列階層標識符清單。 無法用來查閱階層。 可能是 Null。
highlights

Highlights

要向用戶顯示的時間序列實例反白顯示文字。 反白顯示符合搜尋字串之文字部分的插入和 標記。 請勿使用任何醒目提示的屬性來執行進一步的 API 呼叫。
name

string

符合搜尋要求的時間序列實例名稱。 可能是 Null。
timeSeriesId

TimeSeriesId[]

符合搜尋要求之時間序列實例的時間序列標識碼。
typeId

string

表示符合搜尋要求所屬時間序列實例的類型。 絕對不會是 null。

InstancesSortBy

值，用於在搜尋實例呼叫傳回之前排序時間序列實例。 當它設定為 『Rank』 時，傳回的實例會根據相關性來排序。 當它設定為 『DisplayName』 時，傳回的結果會根據顯示名稱排序。 如果實例存在，則顯示名稱是實例的名稱，否則顯示名稱會是時間序列標識元。 預設值為 『Rank』。

名稱 類型 Description
DisplayName

string

Rank

string

InstancesSortParameter

定義在搜尋實例呼叫傳回之前，時間序列實例的排序方式。

名稱 類型 Description
by

InstancesSortBy

值，用於在搜尋實例呼叫傳回之前排序時間序列實例。 當它設定為 『Rank』 時，傳回的實例會根據相關性來排序。 當它設定為 『DisplayName』 時，傳回的結果會根據顯示名稱排序。 如果實例存在，則顯示名稱是實例的名稱，否則顯示名稱會是時間序列標識元。 預設值為 『Rank』。

SearchHierarchyNodesResponse

階層節點，其中包含根據輸入比對查詢的實例。 可以是空白或 Null。

名稱 類型 Description
continuationToken

string

如果傳回，這表示目前的結果代表部分結果。 接續令牌允許取得下一頁的結果。 若要取得查詢結果的下一頁，請使用 「x-ms-continuation」 HTTP 標頭中的接續令牌參數傳送相同的要求。
hitCount

integer

階層節點總數，其中包含根據輸入比對查詢的實例。
hits

HierarchyHit[]

階層節點清單，其中包含根據輸入比對查詢的實例。 可以是空的。

SearchInstancesHierarchiesParameters

如何透過搜尋實例呼叫傳回時間序列實例階層的參數。

名稱 類型 Description
expand

HierarchiesExpandParameter

是否要在相同搜尋實例呼叫中展開階層節點的定義。 選擇性，預設值為 'UntilChildren'。
pageSize

integer

相同層級中要傳回的相同層級中階層數目上限。 選擇性，如果未設定，預設值為10。 範圍從 1 到 100。 如果超出頁面大小的結果，則可以使用接續令牌來擷取下一頁。
sort

HierarchiesSortParameter

階層節點排序的定義。 選擇性，預設值為 'CumulativeInstanceCount'。

SearchInstancesParameters

如何透過搜尋實例呼叫傳回時間序列實例的參數。

名稱 類型 Description
highlights

boolean

反白顯示的搜尋結果定義。 當它設定為 『true』 時，會傳回醒目提示的搜尋結果。 當它設定為 『false』 時，不會傳回醒目提示的搜尋結果。 預設值為 'true'。
pageSize

integer

結果每一頁預期的實例數目上限。 未設定時，預設值為10。 範圍從 1 到 100。 如果超出頁面大小的結果，用戶可以使用接續令牌來擷取下一頁。
recursive

boolean

傳回實例的定義。 當遞歸設定為 『true』 時，會傳回路徑參數開頭為路徑的所有實例。 當遞歸設定為 『false』 時，只會傳回路徑完全符合 path 參數的實例。 使用遞歸搜尋可實作搜尋用戶體驗，而使用非遞歸搜尋則允許實作瀏覽體驗。 選擇性，預設值為 'true'。
sort

InstancesSortParameter

在搜尋實例呼叫 - 相關性或字母順序之前，時間序列實例的排序方式定義。 選擇性，預設值為 “Rank”。

SearchInstancesRequest

要求對時間序列實例執行搜尋查詢，並傳回相符的時間序列實例。

名稱 類型 Description
hierarchies

SearchInstancesHierarchiesParameters

如何傳回時間序列實例階層的參數。 如果為 null，則不會傳回階層。 如果 instances 參數為 null，且階層參數不是 null，則只會傳回沒有實例的階層。
instances

SearchInstancesParameters

如何傳回時間序列實例的參數。 可以是 null。 當實例和階層參數都是 Null 時，系統會根據參數的預設值在結果中傳回實例，而且不會傳回階層。
path

string[]

篩選時間序列實例的階層路徑。 Path 會表示為字串路徑區段的陣列。 第一個專案應該是階層名稱。 範例：[“Location”， “California”]。 選擇性、區分大小寫、永不空白且可為 Null。
searchString

string

會比對時間序列實例屬性的查詢搜尋字串。 範例：「floor 100」。。 不區分大小寫，必須存在，但可以是空字串。

SearchInstancesResponse

根據輸入比對查詢的實例。 可以是空白或 Null。

名稱 類型 Description
continuationToken

string

如果傳回，這表示目前的結果代表部分結果。 接續令牌允許取得下一頁的結果。 若要取得查詢結果的下一頁，請使用 「x-ms-continuation」 HTTP 標頭中的接續令牌參數傳送相同的要求。
hitCount

integer

根據輸入比對查詢的實例總數。
hits

InstanceHit[]

根據輸入比對查詢的實例清單。 可以是空的。

SearchInstancesResponsePage

搜尋結果的單一頁面。

名稱 類型 Description
hierarchyNodes

SearchHierarchyNodesResponse

階層節點，其中包含根據輸入比對查詢的實例。 可以是空白或 Null。
instances

SearchInstancesResponse

根據輸入比對查詢的實例。 可以是空白或 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

人類看得懂且與語言無關的錯誤表示法。 它是開發人員的協助，不適合暴露給終端使用者。