Dela via

Hämta programhändelselista

  • Artikel

Hämtar programrelaterade händelser.

Svaret är en lista över ApplicationEvent-objekt.

Förfrågan

Metod URI för förfrågan
GET /EventsStore/Applications/{applicationId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Parametrar

Namn Typ Obligatorisk Location
applicationId sträng Ja Sökväg
api-version sträng Ja Söka i data
timeout heltal (int64) No Söka i data
StartTimeUtc sträng Ja Söka i data
EndTimeUtc sträng Ja Söka i data
EventsTypesFilter sträng No Söka i data
ExcludeAnalysisEvents boolean No Söka i data
SkipCorrelationLookup boolean No Söka i data

applicationId

Typ: sträng
Obligatoriskt: Ja

Programmets identitet. Detta är vanligtvis det fullständiga namnet på programmet utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om programnamnet till exempel är "fabric:/myapp/app1" skulle programidentiteten vara "myapp~app1" i 6.0+ och "myapp/app1" i tidigare versioner.

api-version

Typ: sträng
Obligatoriskt: Ja
Standard: 6.4

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.4".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Den här versionen är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0 och körningen är 6.1 accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

timeout

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

StartTimeUtc

Typ: sträng
Obligatoriskt: Ja

Starttiden för en uppslagsfråga i ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EndTimeUtc

Typ: sträng
Obligatoriskt: Ja

Sluttiden för en uppslagsfråga i ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Typ: sträng
Obligatoriskt: Nej

Det här är en kommaavgränsad sträng som anger vilka typer av FabricEvents som endast ska ingå i svaret.

ExcludeAnalysisEvents

Typ: booleskt
Obligatoriskt: Nej

Den här param inaktiverar hämtningen av AnalysisEvents om true skickas.

SkipCorrelationLookup

Typ: booleskt
Obligatoriskt: Nej

Den här param inaktiverar sökningen av KorrelatedEvents-information om sant skickas. Annars bearbetas CorrelationEvents och fältet HasCorrelatedEvents i varje FabricEvent fylls i.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) Lista över händelseobjekt med bastypen ApplicationEvent.
 matris med ApplicationEvent
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Det här exemplet visar hur du hämtar alla programrelaterade händelser under en viss tidsperiod.

Förfrågan

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

200-svar

Brödtext
[
  {
    "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
  }
]