Compartilhar via

Obter lista de eventos do aplicativo

  • Artigo

Obtém eventos relacionados a um Aplicativo.

A resposta será uma lista de objetos ApplicationEvent.

Solicitação

Método URI da solicitação
GET /EventsStore/Applications/{applicationId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Parâmetros

Nome Type Obrigatório Location
applicationId string Sim Caminho
api-version string Sim Consulta
timeout inteiro (int64) Não Consulta
StartTimeUtc string Sim Consulta
EndTimeUtc string Sim Consulta
EventsTypesFilter string Não Consulta
ExcludeAnalysisEvents booleano Não Consulta
SkipCorrelationLookup booleano Não Consulta

applicationId

Tipo: string
Obrigatório: sim

A identidade do aplicativo. Normalmente, este é o nome completo do aplicativo sem o esquema de URI "fabric:". A partir da versão 6.0, nomes hierárquicos são delimitados pelo caractere "~". Por exemplo, se o nome do aplicativo for "fabric:/meuaplicativo/aplicativo1", a identidade do aplicativo será "meuaplicativo~aplicativo1" na versão 6.0 e superiores, e "meuaplicativo/aplicativo1" nas versões anteriores.

api-version

Tipo: string
Obrigatório: sim
Padrão: 6.4

A versão da API. Esse parâmetro é necessário e seu valor deve ser '6.4'.

A versão da API REST do Service Fabric baseia-se na versão de runtime na qual a API foi introduzida ou foi alterada. O runtime do Service Fabric dá suporte a mais de uma versão da API. Esta versão é a versão mais recente com suporte da API. Se uma versão inferior da API for passada, a resposta retornada poderá ser diferente daquela documentada nesta especificação.

Além disso, o runtime aceita qualquer versão que seja maior do que a versão mais recente com suporte até a versão atual do runtime. Portanto, se a versão mais recente da API for 6.0 e o runtime for 6.1, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será de acordo com a versão documentada 6.0.

timeout

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tempo limite do servidor para executar a operação em segundos. Especifica o tempo que o cliente está disposto a esperar para que operação solicitada seja concluída. O valor padrão desse parâmetro é 60 segundos.

StartTimeUtc

Tipo: string
Obrigatório: sim

A hora de início de uma consulta de pesquisa no ISO UTC aaaa-MM-ddTHH:mm:ssZ.

EndTimeUtc

Tipo: string
Obrigatório: sim

A hora de término de uma consulta de pesquisa no ISO UTC aaaa-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Tipo: string
Obrigatório: não

Esta é uma cadeia de caracteres separada por vírgula que especifica os tipos de FabricEvents que deverão ser incluídos somente na resposta.

ExcludeAnalysisEvents

Tipo: booliano
Obrigatório: não

Este parâmetro desabilita a recuperação de AnalysisEvents caso true seja aprovado.

SkipCorrelationLookup

Tipo: booliano
Obrigatório: não

Este parâmetro desabilita a pesquisa de informações de CorrelatedEvents caso true seja aprovado. Caso contrário, o CorrelationEvents será processado e o campo HasCorrelatedEvents será preenchido em cada FabricEvent.

Respostas

Código de status HTTP Descrição Esquema de Resposta
200 (OK) Lista de objetos de eventos com o tipo base ApplicationEvent.
 matriz de ApplicationEvent
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Este exemplo mostra como obter todos os eventos relacionados ao aplicativo durante uma determinada janela de tempo.

Solicitação

GET http://localhost:19080/EventsStore/Applications/app1/$/Events?api-version=6.4&StartTimeUtc=2018-04-03T18:00:00Z&EndTimeUtc=2018-04-04T18:00:00Z

Resposta 200

Corpo
[
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App1Type",
    "ApplicationTypeVersion": "1.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app1",
    "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
    "TimeStamp": "2018-04-03T20:21:23.5774199Z",
    "HasCorrelatedEvents": false
  }
]