Time Series Hierarchies - List

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

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

GET https://{environmentFqdn}/timeseries/hierarchies?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	GetHierarchiesPage	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Name

Type

Description

200 OK

GetHierarchiesPage

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

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	олицетворения учетной записи пользователя

Примеры

HierarchiesListPage1

HierarchiesListPage2

HierarchiesListPage3

HierarchiesListPage1

Sample Request

HTTP

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

HTTP

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

HTTP

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

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

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

Source

Определение способа создания уровней дерева иерархии временных рядов.

Name	Type	Description
instanceFieldNames	string[]	Список имен полей экземпляров, которые должны быть заданы во всех экземплярах временных рядов, принадлежащих этой иерархии. Порядок полей экземпляра определяет уровни иерархии.

TimeSeriesHierarchy

Иерархия временных рядов упорядочивает экземпляры временных рядов в дерево.

Name	Type	Description
id	string	Уникальный идентификатор иерархии с учетом регистра. Может иметь значение NULL при создании объектов иерархии, а затем сервер создает идентификатор, а не null при операциях получения и удаления.
name	string	Уникальное имя типа, заданное пользователем. Он является изменяемым и не имеет значения NULL.
source	Source	Определение способа создания уровней дерева иерархии временных рядов.

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	Удобочитаемое, независимое от языка представление ошибки. Она предназначена для разработчиков и не подходит для воздействия на конечных пользователей.