Time Series Instances - List

Referência

Serviço:: Time Series Insights

Versão da API:: 2020-07-31

Obtém instâncias de série temporal em páginas.

GET https://{environmentFqdn}/timeseries/instances?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	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	GetInstancesPage	Operação com êxito. Cabeçalhos x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Cabeçalhos x-ms-request-id: string

Nome

Tipo

Description

200 OK

GetInstancesPage

Operação com êxito.

Cabeçalhos

x-ms-request-id: string

Other Status Codes

TsiError

Erro inesperado.

Cabeçalhos

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

InstancesListPage1

InstancesListPage2

InstancesListPage3

InstancesListPage1

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "instances": []
}

Definições

Nome	Description
GetInstancesPage	Lista parcial de instâncias de série temporal retornadas em uma única solicitação.
TimeSeriesInstance	As instâncias de série temporal são a própria série temporal. Na maioria dos casos, o deviceId ou assetId é o identificador exclusivo do ativo no ambiente. As instâncias têm informações descritivas associadas a elas chamadas campos de instância. No mínimo, os campos de instância incluem informações de hierarquia. Elas também podem incluir dados úteis e descritivos, como fabricante, operador ou última data de serviço.
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.

GetInstancesPage

Lista parcial de instâncias 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".
instances	TimeSeriesInstance[]	Lista parcial de instâncias 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.

TimeSeriesInstance

As instâncias de série temporal são a própria série temporal. Na maioria dos casos, o deviceId ou assetId é o identificador exclusivo do ativo no ambiente. As instâncias têm informações descritivas associadas a elas chamadas campos de instância. No mínimo, os campos de instância incluem informações de hierarquia. Elas também podem incluir dados úteis e descritivos, como fabricante, operador ou última data de serviço.

Nome	Tipo	Description
description	string	Esse campo opcional contém a descrição sobre a instância .
hierarchyIds	string[]	Conjunto de IDs de hierarquia de série temporal às quais a instância pertence. Pode ser nulo.
instanceFields		Conjunto de pares chave-valor que contêm propriedades de instância definidas pelo usuário. Pode não ser nulo. Os tipos de valor de propriedade com suporte são: bool, string, long, double e não pode ser aninhado ou nulo.
name	string	Nome opcional da instância que é exclusiva em um ambiente. Os nomes atuam como um alias mutável ou nome de exibição da instância de série temporal. Mutável, pode ser nulo.
timeSeriesId	TimeSeriesId[]	ID de Série Temporal que identifica exclusivamente a instância. Ele corresponde às propriedades da ID da Série Temporal em um ambiente. Imutável, nunca nulo.
typeId	string	Isso representa o tipo ao qual essa instância pertence. Nunca nulo.

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.

Compartilhar via

Time Series Instances - List

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

InstancesListPage1

Solicitação de exemplo

Resposta de exemplo

InstancesListPage2

Solicitação de exemplo

Resposta de exemplo

InstancesListPage3

Solicitação de exemplo

Resposta de exemplo

Definições

GetInstancesPage

TimeSeriesInstance

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionais