Compartilhar via

Time Series Hierarchies - List

  • Referência
Service:
Time Series Insights
API Version:
2020-07-31

Retorna definições de hierarquias de série temporal em páginas.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentFqdn
 path True

string

Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version
 query True

string

Versão da API a ser usada com a solicitação do cliente. A versão atualmente com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-continuation

string

Token de continuação da página anterior de resultados para recuperar a próxima página dos resultados em chamadas que dão suporte à paginação. Para obter os resultados da primeira página, especifique o token de continuação nula como valor de parâmetro. O token de continuação retornado será nulo se todos os resultados tiverem sido retornados e não houver nenhuma próxima página de resultados.
x-ms-client-request-id

string

ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id

string

ID de sessão do cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Respostas

Nome Tipo Description
200 OK

GetHierarchiesPage

Operação com êxito.

Headers

x-ms-request-id: string
Other Status Codes

TsiError

Erro inesperado.

Headers

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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": []
}

Definições

Nome Description
GetHierarchiesPage

Lista parcial de hierarquias de série temporal retornadas em uma única solicitação.
Source

Definição de como os níveis de árvore de hierarquia de série temporal são criados.
TimeSeriesHierarchy

A hierarquia de série temporal organiza instâncias de série temporal em uma árvore.
TsiError

Informações sobre um erro de API.
TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails

Informações adicionais de erro.

GetHierarchiesPage

Lista parcial de hierarquias de série temporal retornadas em uma única solicitação.

Nome Tipo Description
continuationToken

string

Se retornado, isso significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a próxima página de resultados. Para obter a próxima página de resultados da consulta, envie a mesma solicitação com o parâmetro de token de continuação no cabeçalho HTTP "x-ms-continuation".
hierarchies

TimeSeriesHierarchy[]

Lista parcial de hierarquias de série temporal retornadas em uma única solicitação. Pode ficar vazio se o servidor não puder preencher a página nesta solicitação ou se não houver mais objetos quando o token de continuação for nulo.

Source

Definição de como os níveis de árvore de hierarquia de série temporal são criados.

Nome Tipo Description
instanceFieldNames

string[]

Lista de nomes de campo de instância que devem ser definidos em todas as instâncias de série temporal que pertencem a essa hierarquia. A ordem dos campos de instância define os níveis na hierarquia.

TimeSeriesHierarchy

A hierarquia de série temporal organiza instâncias de série temporal em uma árvore.

Nome Tipo Description
id

string

Identificador de hierarquia exclusiva que diferencia maiúsculas de minúsculas. Pode ser nulo ao criar objetos de hierarquia e, em seguida, o servidor gera a ID, não nulo nas operações get e delete.
name

string

Nome exclusivo fornecido pelo usuário para o tipo. É mutável e não nulo.
source

Source

Definição de como os níveis de árvore de hierarquia de série temporal são criados.

TsiError

Informações sobre um erro de API.

Nome Tipo Description
error

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
details

TsiErrorDetails[]

Contém informações de erro adicionais. Pode ser nulo.
innerError

TsiErrorBody

Contém um erro mais específico que restringe a causa. Pode ser nulo.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.
target

string

Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações adicionais de erro.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.