Share via

Get Applications Event List

  • Article

Gets all Applications-related events.

The response is list of ApplicationEvent objects.

Request

Method Request URI
GET /EventsStore/Applications/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Parameters

Name Type Required Location
api-version string Yes Query
timeout integer (int64) No Query
StartTimeUtc string Yes Query
EndTimeUtc string Yes Query
EventsTypesFilter string No Query
ExcludeAnalysisEvents boolean No Query
SkipCorrelationLookup boolean No Query

api-version

Type: string
Required: Yes
Default: 6.4

The version of the API. This parameter is required and its value must be '6.4'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

StartTimeUtc

Type: string
Required: Yes

The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EndTimeUtc

Type: string
Required: Yes

The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Type: string
Required: No

This is a comma separated string specifying the types of FabricEvents that should only be included in the response.

ExcludeAnalysisEvents

Type: boolean
Required: No

This param disables the retrieval of AnalysisEvents if true is passed.

SkipCorrelationLookup

Type: boolean
Required: No

This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.

Responses

HTTP Status Code Description Response Schema
200 (OK) List of events objects with base type ApplicationEvent.
 array of ApplicationEvent
All other status codes The detailed error response.
 FabricError

Examples

This example shows how to get all applications-related events during a certain time window.

Request

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

200 Response

Body
[
  {
    "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
  },
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App2Type",
    "ApplicationTypeVersion": "4.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app2",
    "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3",
    "TimeStamp": "2018-04-03T20:21:59.74842Z",
    "HasCorrelatedEvents": false
  }
]