Get Service Event List

Gets a Service-related events.

The response is list of ServiceEvent objects.


Method Request URI
GET /EventsStore/Services/{serviceId}/$/Events?api-version=6.2-preview&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}


Name Type Required Location
serviceId string Yes Path
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


Type: string
Required: Yes

The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.


Type: string
Required: Yes
Default: 6.2-preview

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


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.


Type: string
Required: Yes

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


Type: string
Required: Yes

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


Type: string
Required: No

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


Type: boolean
Required: No

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


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.


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


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


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

200 Response

    "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