通过

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

Time Series Hierarchies - List

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

返回页面中的时间序列层次结构定义。

GET https://{environmentFqdn}/timeseries/hierarchies?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-continuation

string

在支持分页的调用中检索结果的下一页的结果的延续标记。 若要获取第一页结果，请将 null 继续标记指定为参数值。 如果返回了所有结果，则返回的继续标记为 null，并且没有下一页的结果。
x-ms-client-request-id

string

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

string

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

响应

名称 类型 说明
200 OK

GetHierarchiesPage

操作成功。

标头

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

示例

HierarchiesListPage1
HierarchiesListPage2
HierarchiesListPage3

HierarchiesListPage1

示例请求

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

示例响应

状态代码:
200 
{
  "hierarchies": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

HierarchiesListPage2

示例请求

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

示例响应

状态代码:
200 
{
  "hierarchies": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

HierarchiesListPage3

示例请求

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

示例响应

状态代码:
200 
{
  "hierarchies": []
}

定义

名称 说明
GetHierarchiesPage

在单个请求中返回的时序层次结构的部分列表。
Source

定义如何创建时序层次结构树级别。
TimeSeriesHierarchy

时序层次结构将时序实例组织到树中。
TsiError

有关 API 错误的信息。
TsiErrorBody

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

其他错误信息。

GetHierarchiesPage

Object

在单个请求中返回的时序层次结构的部分列表。

名称 类型 说明
continuationToken

string

如果返回，则表示当前结果表示部分结果。 继续标记允许获取下一页的结果。 若要获取下一页查询结果，请在“x-ms-continuation”HTTP 标头中使用延续标记参数发送相同的请求。
hierarchies

TimeSeriesHierarchy[]

在单个请求中返回的时序层次结构的部分列表。 如果服务器无法填充此请求中的页面，或者当延续令牌为 null 时没有更多对象，则可以为空。

Source

Object

定义如何创建时序层次结构树级别。

名称 类型 说明
instanceFieldNames

string[]

必须在属于此层次结构的所有时序实例中设置的实例字段名称列表。 实例字段的顺序定义了层次结构中的级别。

TimeSeriesHierarchy

Object

时序层次结构将时序实例组织到树中。

名称 类型 说明
id

string

区分大小写的唯一层次结构标识符。 在创建层次结构对象时可以为 null，然后服务器在获取和删除作时生成 id，而不是 null。
name

string

用户为类型提供的唯一名称。 它是可变的，不是空的。
source

Source

定义如何创建时序层次结构树级别。

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

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