Ottenere l'elenco eventi del servizio

  • Articolo

Ottiene eventi correlati al servizio.

La risposta è un elenco di oggetti ServiceEvent.

Richiesta

Metodo URI richiesta
GET /EventsStore/Services/{serviceId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Parametri

Nome Tipo Necessario Posizione
serviceId string Sì Percorso
api-version string Sì Query
timeout integer (int64) No Query
StartTimeUtc string Sì Query
EndTimeUtc string Sì Query
EventsTypesFilter string No Query
ExcludeAnalysisEvents boolean No Query
SkipCorrelationLookup boolean No Query

serviceId

Tipo: stringa
Obbligatorio: Sì

L'identità del servizio. Questo ID è in genere il nome completo del servizio senza lo schema URI 'fabric:'. A partire dalla versione 6.0, i nomi gerarchici sono delimitati dal carattere "~". Ad esempio, se il nome del servizio è "fabric:/myapp/app1/svc1", l'identità del servizio sarà "myapp~app1~svc1" in 6.0+ e "myapp/app1/svc1" nelle versioni precedenti.

api-version

Tipo: stringa
Obbligatorio: Sì
Impostazione predefinita: 6.4

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.4'.

La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa versione è la versione più recente supportata dell'API. Se viene passata una versione api inferiore, la risposta restituita può essere diversa da quella documentata in questa specifica.

Inoltre, il runtime accetta qualsiasi versione superiore alla versione supportata più recente fino alla versione corrente del runtime. Quindi, se la versione più recente dell'API è 6.0 e il runtime è 6.1, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.

timeout

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

StartTimeUtc

Tipo: stringa
Obbligatorio: Sì

Ora di inizio di una query di ricerca in ISO UTC aaaa-MM-ddTHH:mm:ssZ.

EndTimeUtc

Tipo: stringa
Obbligatorio: Sì

Ora di fine di una query di ricerca in ISO UTC aa-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Tipo: stringa
Obbligatorio: No

Si tratta di una stringa delimitata da virgole che specifica i tipi di FabricEvents che devono essere inclusi solo nella risposta.

ExcludeAnalysisEvents

Tipo: booleano
Obbligatorio: No

Questo param disabilita il recupero di AnalysisEvents se true viene passato.

SkipCorrelationLookup

Tipo: booleano
Obbligatorio: No

Questo param disabilita la ricerca delle informazioni CorrelatedEvents se true viene passato. in caso contrario, il campo CorrelationEvents viene elaborato e HasCorrelatedEvents in ogni fabricEvent viene popolato.

Risposte

Codice di stato HTTP Descrizione Schema di risposta
200 (OK) Elenco di oggetti eventi con tipo di base ServiceEvent.
 matrice di ServiceEvent
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

In questo esempio viene illustrato come ottenere tutti gli eventi correlati al servizio durante un determinato intervallo di tempo.

Richiesta

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

Risposta 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
  }
]