通过

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

Time Series Instances - Suggest

服务:
Time Series Insights
API 版本:
2020-07-31

建议基于时序实例属性的关键字，以便稍后在搜索实例中使用。

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

URI 参数

名称 在 必需 类型 说明
environmentFqdn
 path True

string

每个环境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。 可以从 Get Environments API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version
 query True

string

要用于客户端请求的 API 的版本。 当前支持的版本为“2020-07-31”。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string

可选的客户端请求 ID。 服务记录此值。 允许服务跨服务跟踪作，并允许客户联系有关特定请求的支持人员。
x-ms-client-session-id

string

可选的客户端会话 ID。 服务记录此值。 允许服务跨服务跟踪一组相关作，并允许客户联系有关特定请求组的支持人员。

请求正文

名称 必需 类型 说明
searchString True

string

搜索需要建议的字符串。 允许为空，但不允许为 null。
take

integer (int32)

结果中预期的最大建议数。 如果未设置，则默认值为 10。

响应

名称 类型 说明
200 OK

InstancesSuggestResponse

作成功。

标头

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

TsiError

意外错误。

标头

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

InstancesSuggest

示例请求

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

{
  "searchString": "flo",
  "take": 3
}

示例响应

状态代码:
200 
{
  "suggestions": [
    {
      "searchString": "floor 100",
      "highlightedSearchString": "<hit>flo</hit>or 100"
    },
    {
      "searchString": "sensor on floor 0",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 0"
    },
    {
      "searchString": "sensor on floor 1",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 1"
    }
  ]
}

定义

名称 说明
InstancesSearchStringSuggestion

建议的搜索字符串用于进一步搜索时序实例。
InstancesSuggestRequest

请求根据前缀文本获取时序实例搜索的搜索字符串建议。
InstancesSuggestResponse

获取用于搜索时序实例的建议的响应。
TsiError

有关 API 错误的信息。
TsiErrorBody

具有错误代码和消息的特定 API 错误。
TsiErrorDetails

其他错误信息。

InstancesSearchStringSuggestion

Object

建议的搜索字符串用于进一步搜索时序实例。

名称 类型 说明
highlightedSearchString

string

突出显示了要向用户显示的推荐搜索字符串。 突出显示在 <与搜索字符串匹配的文本部分插入 hit> 和 </hit> 标记。 不要使用突出显示的搜索字符串执行进一步的搜索调用。
searchString

string

建议的搜索字符串。 可用于进一步搜索时序实例。

InstancesSuggestRequest

Object

请求根据前缀文本获取时序实例搜索的搜索字符串建议。

名称 类型 说明
searchString

string

搜索需要建议的字符串。 允许为空，但不允许为 null。
take

integer (int32)

结果中预期的最大建议数。 如果未设置，则默认值为 10。

InstancesSuggestResponse

Object

获取用于搜索时序实例的建议的响应。

名称 类型 说明
suggestions

InstancesSearchStringSuggestion[]

用于搜索时序模型的实例建议列表。

TsiError

Object

有关 API 错误的信息。

名称 类型 说明
error

TsiErrorBody

具有错误代码和消息的特定 API 错误。

TsiErrorBody

Object

具有错误代码和消息的特定 API 错误。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
details

TsiErrorDetails[]

包含其他错误信息。 可以为 null。
innerError

TsiErrorBody

包含更具体的错误，可缩小原因范围。 可以为 null。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。
target

string

特定错误的目标（例如，错误中属性的名称）。 可以为 null。

TsiErrorDetails

Object

其他错误信息。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。