Query - Get Availability

Referência

Serviço:: Time Series Insights

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

Devolve o intervalo de tempo e a distribuição da contagem de eventos ao longo do carimbo de data/hora do evento ($ts). Esta API pode ser utilizada para fornecer experiência de destino de navegação para o ambiente.

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

Com parâmetros opcionais:

GET https://{environmentFqdn}/availability?api-version=2020-07-31&storeType={storeType}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
environmentFqdn	path	True	string	FQDN por ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Pode obter este nome de domínio a partir da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atualmente suportada é "2020-07-31".
storeType	query		string	Para os ambientes com o arquivo quente ativado, a consulta pode ser executada no "WarmStore" ou no "ColdStore". Este parâmetro na consulta define em que arquivo a consulta deve ser executada. Se não estiver definida, a consulta será executada no arquivo a frio.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string	ID de pedido de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia a operação entre serviços e permite que o cliente contacte o suporte relativamente a um pedido específico.
x-ms-client-session-id		string	ID de sessão de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia um grupo de operações relacionadas entre serviços e permite que o cliente contacte o suporte relativamente a um grupo específico de pedidos.

Respostas

Name	Tipo	Description
200 OK	AvailabilityResponse	Operação bem-sucedida. Cabeçalhos x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Cabeçalhos x-ms-request-id: string

Name

Tipo

Description

200 OK

AvailabilityResponse

Operação bem-sucedida.

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 OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

AvailabilityGetEmpty

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{}

ColdStoreAvailabilityGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

WarmStoreAvailabilityGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

Definições

Name	Description
Availability	Informações de disponibilidade de eventos quando o ambiente contém eventos. Contém um intervalo de tempo de eventos e uma distribuição aproximada de eventos ao longo do tempo.
AvailabilityResponse	Resposta da operação Obter Disponibilidade. Quando o ambiente não tem dados, a propriedade de disponibilidade é nula.
DateTimeRange	O intervalo de tempo. Não pode ser nulo ou negativo.
TsiError	Informações sobre um erro de API.
TsiErrorBody	Um erro específico da API com um código de erro e uma mensagem.
TsiErrorDetails	Informações de erro adicionais.

Availability

Informações de disponibilidade de eventos quando o ambiente contém eventos. Contém um intervalo de tempo de eventos e uma distribuição aproximada de eventos ao longo do tempo.

Name	Tipo	Description
distribution	object
intervalSize	string	Tamanho do intervalo para a distribuição devolvida dos eventos. O intervalo devolvido está selecionado para devolver um número razoável de pontos. Todos os intervalos têm o mesmo tamanho. No intervalo de fio é especificado no formato de duração ISO-8601. Um mês é sempre convertido em 30 dias e um ano é sempre 365 dias. Exemplos: 1 minuto é "PT1M", 1 milissegundo é "PT0.001S". Para mais informações, consulte https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Valores mínimos e máximos da propriedade de carimbo de data/hora do evento ($ts).

AvailabilityResponse

Resposta da operação Obter Disponibilidade. Quando o ambiente não tem dados, a propriedade de disponibilidade é nula.

Name	Tipo	Description
availability	Availability	Informações de disponibilidade de eventos quando o ambiente contém eventos. Quando o ambiente ainda não tem dados, esta propriedade é nula ou não está presente.

DateTimeRange

O intervalo de tempo. Não pode ser nulo ou negativo.

Name	Tipo	Description
from	string	Carimbo de data/hora de início do intervalo de tempo. O carimbo de data/hora de início é inclusivo quando utilizado em pedidos de consulta de série temporal. Os eventos que têm este carimbo de data/hora estão incluídos.
to	string	Carimbo de data/hora de fim do intervalo de tempo. O carimbo de data/hora de fim é exclusivo quando utilizado em pedidos de consulta de série temporal. Os eventos que correspondam a este carimbo de data/hora são excluídos. Tenha em atenção que o carimbo de data/hora de fim é inclusivo quando devolvido pela opção Obter Disponibilidade (o que significa que existe um evento com este carimbo de data/hora exato de "para").

TsiError

Informações sobre um erro de API.

Name	Tipo	Description
error	TsiErrorBody	Um erro específico da API com um código de erro e uma mensagem.

TsiErrorBody

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

Name	Tipo	Description
code	string	Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente 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 do erro legível por humanos e independente da linguagem. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.
target	string	Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações de erro adicionais.

Name	Tipo	Description
code	string	Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos.
message	string	Representação do erro legível por humanos e independente da linguagem. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais.

Partilhar via

Query - Get Availability

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

AvailabilityGet

Pedido de amostra

Resposta da amostra

AvailabilityGetEmpty

Pedido de amostra

Resposta da amostra

ColdStoreAvailabilityGet

Pedido de amostra

Resposta da amostra

WarmStoreAvailabilityGet

Pedido de amostra

Resposta da amostra

Definições

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionais