Time Series Instances - List

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

Возвращает экземпляры временных рядов на страницах.

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

Параметры URI

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API get Environments, портал Azure или Azure Resource Manager.
api-version	query	True	string	Версия API, используемая с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.

Заголовок запроса

Name	Type	Description
x-ms-continuation	string	Маркер продолжения из предыдущей страницы результатов для получения следующей страницы результатов в вызовах, поддерживающих разбиение на страницы. Чтобы получить результаты первой страницы, укажите токен продолжения NULL в качестве значения параметра. Возвращенный маркер продолжения имеет значение NULL, если все результаты были возвращены, а следующая страница результатов отсутствует.
x-ms-client-request-id	string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки в отношении конкретного запроса.
x-ms-client-session-id	string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки в отношении определенной группы запросов.

Ответы

Name	Type	Description
200 OK	GetInstancesPage	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Name

Type

Description

200 OK

GetInstancesPage

Успешная операция.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Непредвиденная ошибка.

Headers

x-ms-request-id: string

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

InstancesListPage1

InstancesListPage2

InstancesListPage3

InstancesListPage1

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "instances": []
}

Определения

GetInstancesPage	Частичный список экземпляров временных рядов, возвращаемых в одном запросе.
TimeSeriesInstance	Экземпляры временных рядов — это сами временные ряды. В большинстве случаев они представляют собой DeviceID или AssetID — уникальный идентификатор ресурса в среде. Экземпляры содержат описательные сведения, связанные с ними, называемые полями экземпляров. Как минимум поля экземпляра включают сведения о иерархии. Они также могут содержать полезные, описательные данные, например сведения о производителе, операторе или дату последнего обновления.
TsiError	Сведения об ошибке API.
TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

GetInstancesPage

Частичный список экземпляров временных рядов, возвращаемых в одном запросе.

Name	Type	Description
continuationToken	string	При возвращении это означает, что текущие результаты представляют частичный результат. Токен продолжения позволяет получить следующую страницу результатов. Чтобы получить следующую страницу результатов запроса, отправьте тот же запрос с параметром токена продолжения в заголовке HTTP x-ms-continuation.
instances	TimeSeriesInstance[]	Частичный список экземпляров временных рядов, возвращаемых в одном запросе. Может быть пустым, если серверу не удалось заполнить страницу в этом запросе или больше нет объектов, если маркер продолжения имеет значение NULL.

TimeSeriesInstance

Экземпляры временных рядов — это сами временные ряды. В большинстве случаев они представляют собой DeviceID или AssetID — уникальный идентификатор ресурса в среде. Экземпляры содержат описательные сведения, связанные с ними, называемые полями экземпляров. Как минимум поля экземпляра включают сведения о иерархии. Они также могут содержать полезные, описательные данные, например сведения о производителе, операторе или дату последнего обновления.

Name	Type	Description
description	string	Это необязательное поле содержит описание экземпляра.
hierarchyIds	string[]	Набор идентификаторов иерархии временных рядов, к которым принадлежит экземпляр. Может принимать значение NULL.
instanceFields		Набор пар "ключ-значение", содержащих пользовательские свойства экземпляра. Значение может быть равно null. Поддерживаемые типы значений свойств: bool, string, long, double и не могут быть вложенными или пустыми.
name	string	Необязательное имя экземпляра, уникального в среде. Имена действуют как изменяемый псевдоним или отображаемое имя экземпляра временных рядов. Изменяемый, может иметь значение NULL.
timeSeriesId	TimeSeriesId[]	Идентификатор временных рядов, который однозначно идентифицирует экземпляр. Он соответствует свойствам идентификатора временных рядов в среде. Неизменяемый, никогда не пустой.
typeId	string	Это представляет тип, к которому принадлежит данный экземпляр. Никогда не равно NULL.

TsiError

Сведения об ошибке API.

Name	Type	Description
error	TsiErrorBody	Конкретная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Конкретная ошибка API с кодом ошибки и сообщением.

Name	Type	Description
code	string	Независимая от языка строка, читаемая человеком, которая определяет код ошибки, относящуюся к конкретной службе. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Можно использовать для программной обработки конкретных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для воздействия на конечных пользователей.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Name	Type	Description
code	string	Независимая от языка строка, читаемая человеком, которая определяет код ошибки, относящуюся к конкретной службе. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Можно использовать для программной обработки конкретных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для воздействия на конечных пользователей.