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

Time Series Hierarchies - List

  • 参考
Service:
Time Series Insights
API Version:
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。 可以从获取环境 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

成功的操作。

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

示例

HierarchiesListPage1
HierarchiesListPage2
HierarchiesListPage3

HierarchiesListPage1

Sample Request

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

Sample Response

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

HierarchiesListPage2

Sample Request

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

Sample Response

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

HierarchiesListPage3

Sample Request

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

Sample Response

Status code:
200 
{
  "hierarchies": []
}

定义

名称 说明
GetHierarchiesPage

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

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

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

有关 API 错误的信息。
TsiErrorBody

包含错误代码和消息的特定 API 错误。
TsiErrorDetails

其他错误信息。

GetHierarchiesPage

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

名称 类型 说明
continuationToken

string

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

TimeSeriesHierarchy[]

在单个请求中返回的部分时序层次结构列表。 如果服务器无法填充此请求中的页面，或者继续标记为 null 时不再有对象，则可为空。

Source

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

名称 类型 说明
instanceFieldNames

string[]

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

TimeSeriesHierarchy

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

名称 类型 说明
id

string

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

string

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

Source

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

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

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