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

Time Series Instances - Search

参考

Service:: Time Series Insights

API Version:: 2020-07-31

基于实例属性搜索时序实例的部分命中数列表。

POST https://{environmentFqdn}/timeseries/instances/search?api-version=2020-07-31

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

请求头

名称	类型	说明
x-ms-continuation	string	上一页结果中的延续标记，用于在支持分页的调用中检索结果的下一页。若要获取第一页结果，请将 null 延续标记指定为参数值。如果已返回所有结果，则返回的延续标记为 null，并且没有下一页的结果。
x-ms-client-request-id	string	可选的客户端请求 ID。服务记录此值。允许服务跨服务跟踪操作，并允许客户就特定请求联系支持人员。
x-ms-client-session-id	string	可选的客户端会话 ID。服务记录此值。允许服务跨服务跟踪一组相关操作，并允许客户就特定请求组联系支持人员。

请求正文

名称	必需	类型	说明
searchString	True	string	将与时序实例的属性匹配的查询搜索字符串。示例：“floor 100”。不区分大小写，必须存在，但可以是空字符串。
hierarchies		SearchInstancesHierarchiesParameters	如何返回时序实例层次结构的参数。如果为 null，则不返回层次结构。如果 instances 参数为 null 且层次结构参数不为 null，则仅返回不包含实例的层次结构。
instances		SearchInstancesParameters	如何返回时序实例的参数。可以为 null。当实例和层次结构参数均为 null 时，将根据参数的默认值在结果中返回实例，并且不返回层次结构。
path		string[]	筛选时序实例的层次结构路径。 Path 表示为字符串路径段数组。第一个元素应为层次结构名称。示例：[“Location”， “California”]。可选，区分大小写，从不为空，可以为 null。

响应

名称	类型	说明
200 OK	SearchInstancesResponsePage	搜索响应成功。 Headers x-ms-request-id: string
Other Status Codes	TsiError	意外错误。 Headers x-ms-request-id: string

名称

类型

说明

200 OK

SearchInstancesResponsePage

搜索响应成功。

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

示例

SearchInstancesDefault

SearchInstancesExpandHierarchiesOnly

SearchInstancesHierarchiesDefaultInputPage1

SearchInstancesHierarchiesDefaultInputPage2

SearchInstancesHierarchiesDefaultInputPage3

SearchInstancesOneLevel

SearchInstancesRecursive

SearchInstancesUntilChildren

SearchInstancesDefault

Sample Request

HTTP

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

{
  "searchString": "floor 100"
}

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

SearchInstancesRecursive

Sample Request

HTTP

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
}

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

定义

名称	说明
HierarchiesExpandKind	层次结构节点的扩展类型。当它设置为“UntilChildren”时，层次结构节点将递归展开，直到有多个子节点。当设置为“OneLevel”时，层次结构仅在匹配路径搜索实例参数的单一级别展开。可选，默认值为“UntilChildren”。
HierarchiesExpandParameter	定义是否在同一搜索实例调用中展开层次结构节点。
HierarchiesSortBy	用于层次结构节点排序的值。如果设置为“CumulativeInstanceCount”，则根据属于层次结构节点及其子层次结构节点的实例总数对返回的层次结构进行排序。当它设置为“Name”时，返回的层次结构将基于层次结构名称进行排序。可选，默认值为“CumulativeInstanceCount”。
HierarchiesSortParameter	层次结构节点排序的定义。
HierarchyHit	层次结构节点，其中包含与基于输入的查询匹配的实例。可以为空或 null。
Highlights	要向用户显示的时序实例的突出显示文本。突出显示与搜索字符串匹配的文本部分中的插入和标记。请勿使用任何突出显示的属性执行进一步的 API 调用。
InstanceHit	实例搜索调用返回的时序实例。返回的实例与搜索请求匹配，并包含要向用户显示（如果设置为“true”）的突出显示文本。
InstancesSortBy	搜索实例调用返回之前用于对时序实例进行排序的值。当它设置为“Rank”时，将基于相关性对返回的实例进行排序。当它设置为“DisplayName”时，返回的结果将基于显示名称进行排序。显示名称是实例的名称（如果存在），否则，显示名称是时序 ID。默认值为“Rank”。
InstancesSortParameter	定义在搜索实例调用返回前时序实例的排序方式。
SearchHierarchyNodesResponse	层次结构节点，其中包含与基于输入的查询匹配的实例。可以为空或 null。
SearchInstancesHierarchiesParameters	如何通过搜索实例调用返回时序实例层次结构的参数。
SearchInstancesParameters	如何通过搜索实例调用返回时序实例的参数。
SearchInstancesRequest	请求对时序实例执行搜索查询并返回匹配的时序实例。
SearchInstancesResponse	根据输入匹配查询的实例。可以为空或 null。
SearchInstancesResponsePage	搜索结果的单个页面。
TsiError	有关 API 错误的信息。
TsiErrorBody	包含错误代码和消息的特定 API 错误。
TsiErrorDetails	其他错误信息。

HierarchiesExpandKind

层次结构节点的扩展类型。当它设置为“UntilChildren”时，层次结构节点将递归展开，直到有多个子节点。当设置为“OneLevel”时，层次结构仅在匹配路径搜索实例参数的单一级别展开。可选，默认值为“UntilChildren”。

名称	类型	说明
OneLevel	string
UntilChildren	string

HierarchiesExpandParameter

定义是否在同一搜索实例调用中展开层次结构节点。

名称	类型	说明
kind	HierarchiesExpandKind	层次结构节点的扩展类型。当它设置为“UntilChildren”时，层次结构节点将递归展开，直到有多个子节点。当设置为“OneLevel”时，层次结构仅在匹配路径搜索实例参数的单一级别展开。可选，默认值为“UntilChildren”。

HierarchiesSortBy

用于层次结构节点排序的值。如果设置为“CumulativeInstanceCount”，则根据属于层次结构节点及其子层次结构节点的实例总数对返回的层次结构进行排序。当它设置为“Name”时，返回的层次结构将基于层次结构名称进行排序。可选，默认值为“CumulativeInstanceCount”。

名称	类型	说明
CumulativeInstanceCount	string
Name	string

HierarchiesSortParameter

层次结构节点排序的定义。

名称	类型	说明
by	HierarchiesSortBy	用于层次结构节点排序的值。如果设置为“CumulativeInstanceCount”，则根据属于层次结构节点及其子层次结构节点的实例总数对返回的层次结构进行排序。当它设置为“Name”时，返回的层次结构将基于层次结构名称进行排序。可选，默认值为“CumulativeInstanceCount”。

HierarchyHit

层次结构节点，其中包含与基于输入的查询匹配的实例。可以为空或 null。

名称	类型	说明
cumulativeInstanceCount	integer	属于此节点及其与查询匹配的子树的实例总数。
hierarchyNodes	SearchHierarchyNodesResponse	此节点的子层次结构节点。可以为空或 null。
name	string	层次结构节点的名称。可以为空，不能为 null。

Highlights

要向用户显示的时序实例的突出显示文本。突出显示与搜索字符串匹配的文本部分中的插入和标记。请勿使用任何突出显示的属性执行进一步的 API 调用。

名称	类型	说明
description	string	突出显示时序实例的说明。可能为 null。
hierarchyIds	string[]	时序实例所属的突出显示时序层次结构 ID 的列表。不能用于查找层次结构。可能为 null。
hierarchyNames	string[]	时序实例所属的突出显示时序层次结构名称的列表。不能用于查找层次结构。可能为 null。
instanceFieldNames	string[]	突出显示的时序实例字段名称的列表。可能为 null。
instanceFieldValues	string[]	突出显示的时序实例字段值的列表。可能为 null。
name	string	突出显示时序实例的名称。可能为 null。
timeSeriesId	string[]	用于显示的时序 ID 的突出显示字符串值的列表。不能用于查找实例。
typeName	string	突出显示了此实例所属的时序类型名称。

InstanceHit

实例搜索调用返回的时序实例。返回的实例与搜索请求匹配，并包含要向用户显示（如果设置为“true”）的突出显示文本。

名称	类型	说明
hierarchyIds	string[]	与搜索请求匹配的时序实例所属的时序层次结构 ID 列表。不能用于查找层次结构。可能为 null。
highlights	Highlights	要向用户显示的时序实例的突出显示文本。突出显示与搜索字符串匹配的文本部分中的插入和标记。请勿使用任何突出显示的属性执行进一步的 API 调用。
name	string	与搜索请求匹配的时序实例的名称。可能为 null。
timeSeriesId	TimeSeriesId[]	与搜索请求匹配的时序实例的时序 ID。
typeId	string	表示与搜索请求匹配的时序实例所属的类型。决不会为 null。

InstancesSortBy

搜索实例调用返回之前用于对时序实例进行排序的值。当它设置为“Rank”时，将基于相关性对返回的实例进行排序。当它设置为“DisplayName”时，返回的结果将基于显示名称进行排序。显示名称是实例的名称（如果存在），否则，显示名称是时序 ID。默认值为“Rank”。

名称	类型	说明
DisplayName	string
Rank	string

InstancesSortParameter

定义在搜索实例调用返回前时序实例的排序方式。

名称	类型	说明
by	InstancesSortBy	搜索实例调用返回之前用于对时序实例进行排序的值。当它设置为“Rank”时，将基于相关性对返回的实例进行排序。当它设置为“DisplayName”时，返回的结果将基于显示名称进行排序。显示名称是实例的名称（如果存在），否则，显示名称是时序 ID。默认值为“Rank”。

SearchHierarchyNodesResponse

层次结构节点，其中包含与基于输入的查询匹配的实例。可以为空或 null。

名称	类型	说明
continuationToken	string	如果返回，则表示当前结果表示部分结果。延续标记允许获取下一页的结果。若要获取查询结果的下一页，请在“x-ms-continuation”HTTP 标头中使用延续令牌参数发送相同的请求。
hitCount	integer	包含与基于输入的查询匹配的实例的层次结构节点总数。
hits	HierarchyHit[]	层次结构节点的列表，其中包含与基于输入的查询匹配的实例。可能为空。

SearchInstancesHierarchiesParameters

如何通过搜索实例调用返回时序实例层次结构的参数。

名称	类型	说明
expand	HierarchiesExpandParameter	定义是否在同一搜索实例调用中展开层次结构节点。可选，默认值为“UntilChildren”。
pageSize	integer	同一级别中要在同一页中返回的最大层次结构数。可选，未设置时默认值为 10。范围为 1 到 100。如果结果超出页面大小，则可以使用延续标记提取下一页。
sort	HierarchiesSortParameter	层次结构节点排序的定义。可选，默认值为“CumulativeInstanceCount”。

SearchInstancesParameters

如何通过搜索实例调用返回时序实例的参数。

名称	类型	说明
highlights	boolean	是否突出显示的搜索结果的定义。当它设置为“true”时，将返回突出显示的搜索结果。如果设置为“false”，则不会返回突出显示的搜索结果。默认值为 "true"。
pageSize	integer	结果的每页中预期的最大实例数。如果未设置，则默认为 10。范围为 1 到 100。如果结果超出页面大小，则用户可以使用延续令牌提取下一页。
recursive	boolean	返回哪些实例的定义。当递归设置为“true”时，将返回以 path 参数路径开头的路径的所有实例。当递归设置为“false”时，仅返回路径与路径参数完全匹配的实例。使用递归搜索可以实现搜索用户体验，而使用非递归搜索可以实现导航体验。可选，默认值为“true”。
sort	InstancesSortParameter	定义时序实例在搜索实例调用返回之前如何排序 - 相关性或字母顺序。可选，默认值为“Rank”。

SearchInstancesRequest

请求对时序实例执行搜索查询并返回匹配的时序实例。

名称	类型	说明
hierarchies	SearchInstancesHierarchiesParameters	如何返回时序实例层次结构的参数。如果为 null，则不返回层次结构。如果 instances 参数为 null 且层次结构参数不为 null，则仅返回不包含实例的层次结构。
instances	SearchInstancesParameters	如何返回时序实例的参数。可以为 null。当实例和层次结构参数均为 null 时，将根据参数的默认值在结果中返回实例，并且不返回层次结构。
path	string[]	筛选时序实例的层次结构路径。 Path 表示为字符串路径段数组。第一个元素应为层次结构名称。示例：[“Location”， “California”]。可选，区分大小写，从不为空，可以为 null。
searchString	string	将与时序实例的属性匹配的查询搜索字符串。示例：“floor 100”。不区分大小写，必须存在，但可以是空字符串。

SearchInstancesResponse

根据输入匹配查询的实例。可以为空或 null。

名称	类型	说明
continuationToken	string	如果返回，则表示当前结果表示部分结果。延续标记允许获取下一页的结果。若要获取查询结果的下一页，请在“x-ms-continuation”HTTP 标头中使用延续令牌参数发送相同的请求。
hitCount	integer	根据输入匹配查询的实例总数。
hits	InstanceHit[]	根据输入匹配查询的实例列表。可能为空。

SearchInstancesResponsePage

搜索结果的单个页面。

名称	类型	说明
hierarchyNodes	SearchHierarchyNodesResponse	层次结构节点，其中包含与基于输入的查询匹配的实例。可以为空或 null。
instances	SearchInstancesResponse	根据输入匹配查询的实例。可以为空或 null。

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

Time Series Instances - Search

URI 参数

请求头

请求正文

响应

安全性

azure_auth

Scopes

示例

SearchInstancesDefault

Sample Request

Sample Response

SearchInstancesExpandHierarchiesOnly

Sample Request

Sample Response

SearchInstancesHierarchiesDefaultInputPage1

Sample Request

Sample Response

SearchInstancesHierarchiesDefaultInputPage2

Sample Request

Sample Response

SearchInstancesHierarchiesDefaultInputPage3

Sample Request

Sample Response

SearchInstancesOneLevel

Sample Request

Sample Response

SearchInstancesRecursive

Sample Request

Sample Response

SearchInstancesUntilChildren

Sample Request

Sample Response

定义

HierarchiesExpandKind

HierarchiesExpandParameter

HierarchiesSortBy

HierarchiesSortParameter

HierarchyHit

Highlights

InstanceHit

InstancesSortBy

InstancesSortParameter

SearchHierarchyNodesResponse

SearchInstancesHierarchiesParameters

SearchInstancesParameters

SearchInstancesRequest

SearchInstancesResponse

SearchInstancesResponsePage

TsiError

TsiErrorBody

TsiErrorDetails

其他资源