Obter Lista de Eventos de Serviço

  • Artigo

Obtém eventos relacionados com o Serviço.

A resposta é a lista de objetos ServiceEvent.

Pedir

Método URI do pedido
GET /EventsStore/Services/{serviceId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Parâmetros

Nome Tipo Necessário Localização
serviceId string Yes Caminho
api-version string Yes Consulta
timeout número inteiro (int64) No Consulta
StartTimeUtc string Yes Consulta
EndTimeUtc string Yes Consulta
EventsTypesFilter cadeia (de carateres) No Consulta
ExcludeAnalysisEvents boolean No Consulta
SkipCorrelationLookup boolean No Consulta

serviceId

Tipo: cadeia
Obrigatório: Sim

A identidade do serviço. Normalmente, este ID é o nome completo do serviço sem o esquema de URI "fabric:". A partir da versão 6.0, os nomes hierárquicos são delimitados com o caráter "~". Por exemplo, se o nome do serviço for "fabric:/myapp/app1/svc1", a identidade do serviço será "myapp~app1~svc1" em 6.0+ e "myapp/app1/svc1" em versões anteriores.

api-version

Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.4

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 alterada. O runtime do Service Fabric suporta mais do que uma versão da API. Esta versão é a versão suportada mais recente da API. Se for transmitida uma versão inferior da API, a resposta devolvida poderá ser diferente da documentada nesta especificação.

Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à versão atual do runtime. Por isso, se a versão mais recente da API for a 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 6.0 documentada.

timeout

Tipo: número inteiro (int64)
Obrigatório: Não
Predefinição: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

O tempo limite do servidor para executar a operação em segundos. Este tempo limite especifica a duração de tempo que o cliente está disposto a aguardar que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

StartTimeUtc

Tipo: cadeia
Obrigatório: Sim

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

EndTimeUtc

Tipo: cadeia
Obrigatório: Sim

A hora de fim de uma consulta de pesquisa em ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Tipo: cadeia
Obrigatório: Não

Esta é uma cadeia separada por vírgulas que especifica os tipos de FabricEvents que só devem ser incluídos na resposta.

ExcludeAnalysisEvents

Tipo: booleano
Obrigatório: Não

Este parâmetro desativa a obtenção de AnalysisEvents se for transmitido true.

SkipCorrelationLookup

Tipo: booleano
Obrigatório: Não

Este parâmetro desativa a pesquisa de informações correlatedEvents se for transmitido true. caso contrário, os CorrelationEvents são processados e o campo HasCorrelatedEvents em cada FabricEvent é preenchido.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Lista de objetos de eventos com o tipo base ServiceEvent.
 matriz de ServiceEvent
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Este exemplo mostra como obter todos os eventos relacionados com o serviço durante um determinado período de tempo.

Pedir

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

Resposta 200

Corpo
[
  {
    "Kind": "ServiceCreated",
    "ServiceTypeName": "Svc1Type",
    "ApplicationName": "fabric:/app1",
    "ApplicationTypeName": "App1Type",
    "ServiceInstance": "131672605579916060",
    "IsStateful": true,
    "PartitionCount": "2",
    "TargetReplicaSetSize": "3",
    "MinReplicaSetSize": "2",
    "ServicePackageVersion": "1.0:1.0",
    "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87",
    "ServiceId": "app1/svc1",
    "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003",
    "TimeStamp": "2018-04-03T20:22:38.0560496Z",
    "HasCorrelatedEvents": false
  }
]