通过

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

Time Series Instances - List

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

获取页面中的时序实例。

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

GetInstancesPage

操作成功。

标头

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

示例

InstancesListPage1
InstancesListPage2
InstancesListPage3

InstancesListPage1

示例请求

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

示例响应

状态代码:
200 
{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

InstancesListPage2

示例请求

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

示例响应

状态代码:
200 
{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "timeSeriesId": [
        "fe984fd0-f632-49ab-990e-3ded259e29b8",
        "T1"
      ],
      "description": "ContosoFarm1W6_GridVoltage3",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GridVoltagePhase3",
        "Plant": "Contoso Plant 1",
        "Unit": "W6",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

InstancesListPage3

示例请求

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

示例响应

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

定义

名称 说明
GetInstancesPage

单个请求中返回的时序实例的部分列表。
TimeSeriesInstance

时序实例是时序本身。 在大多数情况下，deviceId 或 assetId 是环境中资产的唯一标识符。 实例具有与之关联的描述性信息，称为实例字段。 实例字段至少包含层次结构信息。 它们还可以包括有用的描述性数据，例如制造商、运营商或最后服务日期。
TsiError

有关 API 错误的信息。
TsiErrorBody

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

其他错误信息。

GetInstancesPage

Object

单个请求中返回的时序实例的部分列表。

名称 类型 说明
continuationToken

string

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

TimeSeriesInstance[]

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

TimeSeriesInstance

Object

时序实例是时序本身。 在大多数情况下，deviceId 或 assetId 是环境中资产的唯一标识符。 实例具有与之关联的描述性信息，称为实例字段。 实例字段至少包含层次结构信息。 它们还可以包括有用的描述性数据，例如制造商、运营商或最后服务日期。

名称 类型 说明
description

string

此可选字段包含有关实例的说明。
hierarchyIds

string[]

实例所属的时序层次结构 ID 集。 可以为 null。
instanceFields

包含用户定义的实例属性的键值对集。 它可能是空。 支持的属性值类型为：bool、string、long、double，并且不能嵌套或 null。
name

string

在环境中唯一的实例的可选名称。 名称充当时序实例的可变别名或显示名称。 可变，可能为 null。
timeSeriesId

TimeSeriesId[]

唯一标识实例的时序 ID。 它与环境中的时序 ID 属性匹配。 不可变，从不为空。
typeId

string

这表示此实例所属的类型。 从不为 null。

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

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