Query - Get Availability

Referência

Service:: Time Series Insights

API Version:: 2020-07-31

Retorna o intervalo de tempo e a distribuição da contagem de eventos sobre o carimbo de data/hora do evento ($ts). Essa API pode ser usada para fornecer experiência de aterrissagem de navegação até o ambiente.

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

With optional parameters:

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

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. Atualmente, a versão com suporte é "2020-07-31".
storeType	query		string	Para os ambientes com o repositório warm habilitado, a consulta pode ser executada no 'WarmStore' ou no 'ColdStore'. Esse parâmetro na consulta define em qual armazenamento a consulta deve ser executada. Se ele não estiver definido, a consulta será executada no armazenamento cold.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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 os 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 opcional da sessão do cliente. 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	AvailabilityResponse	Operação com êxito. Headers x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Headers x-ms-request-id: string

Nome

Tipo

Description

200 OK

AvailabilityResponse

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

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

{
  "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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{}

ColdStoreAvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

{
  "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

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

{
  "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

Nome	Description
Availability	Informações de disponibilidade de eventos quando o ambiente contém eventos. Contém intervalo de tempo de eventos e 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 de API específico com um código de erro e uma mensagem.
TsiErrorDetails	Informações adicionais de erro.

Availability

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

Nome	Tipo	Description
distribution	object
intervalSize	string	Tamanho do intervalo para a distribuição retornada dos eventos. O intervalo retornado é selecionado para retornar 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 obter 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.

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

DateTimeRange

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

Nome	Tipo	Description
from	string	Iniciar carimbo de data/hora do intervalo de tempo. O carimbo de data/hora de início é inclusivo quando usado em solicitações de consulta de série temporal. Os eventos que têm esse carimbo de data/hora são incluídos.
to	string	Carimbo de data/hora final do intervalo de tempo. O carimbo de data/hora final é exclusivo quando usado em solicitações de consulta de série temporal. Os eventos que correspondem a esse carimbo de data/hora são excluídos. Observe que o carimbo de data/hora final é inclusivo quando retornado por Obter Disponibilidade (o que significa que há um evento com esse carimbo de data/hora exato "para").

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 independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos 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 independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais.

Share via

Query - Get Availability

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definições

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionais