Dienstereignisliste abrufen

  • Artikel

Ruft alle dienstbezogenen Ereignisse ab.

Die Antwort ist eine Liste von ServiceEvent-Objekten.

Anforderung

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

Parameter

Name type Erforderlich Standort
serviceId Zeichenfolge Ja Pfad
api-version Zeichenfolge Ja Abfrage
timeout ganze Zahl (int64) Nein Abfrage
StartTimeUtc Zeichenfolge Ja Abfrage
EndTimeUtc Zeichenfolge Ja Abfrage
EventsTypesFilter Zeichenfolge Nein Abfrage
ExcludeAnalysisEvents boolean Nein Abfrage
SkipCorrelationLookup boolean Nein Abfrage

serviceId

Typ: Zeichenfolge
Erforderlich: Ja

Die Identität (ID) des Diensts. Diese ID ist üblicherweise der vollständige Name des Diensts ohne das URI-Schema „fabric“. Ab Version 6.0 wird für hierarchische Namen das Zeichen „~“ als Trennzeichen verwendet. Wenn der Dienstname beispielsweise „fabric:/myapp/app1/svc1“ lautet, würde die Dienstidentität ab 6.0 „myapp~app1~svc1“ und in früheren Versionen „myapp/app1/svc1“ lauten.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.4" sein.

Die Service Fabric-REST-API-Version basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Diese Version ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 und die Runtime 6.1 ist, akzeptiert die Runtime Version 6.1 für diese API. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

StartTimeUtc

Typ: Zeichenfolge
Erforderlich: Ja

Die Startzeit einer Lookupabfrage in ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EndTimeUtc

Typ: Zeichenfolge
Erforderlich: Ja

Die Endzeit einer Lookupabfrage in ISO UTC yyyy-MM-ddTHH:mm:ssZ.

EventsTypesFilter

Typ: Zeichenfolge
Erforderlich: Nein

Dies ist eine durch Trennzeichen getrennte Zeichenfolge, die die Typen von FabricEvents angibt, die nur in der Antwort enthalten sein sollten.

ExcludeAnalysisEvents

Typ: boolesch
Erforderlich: Nein

Dieser Parameter deaktiviert den Abruf von AnalysisEvents, wenn „true“ übergeben wird.

SkipCorrelationLookup

Typ: boolesch
Erforderlich: Nein

Dieser Parameter deaktiviert die Suche nach CorrelatedEvents-Informationen, wenn „true“ übergeben wird. Andernfalls werden die CorrelationEvents verarbeitet und das Feld „HasCorrelatedEvents“ in jedem FabricEvent ausgefüllt.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Liste der Ereignisobjekte mit dem Basistyp ServiceEvent.
 Array von ServiceEvent
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

In diesem Beispiel wird gezeigt, wie alle dienstbezogenen Ereignisse während eines bestimmten Zeitfensters abgerufen werden.

Anforderung

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

Antwort 200

Text
[
  {
    "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
  }
]