Pobieranie listy zdarzeń usługi
Pobiera zdarzenia związane z usługą.
Odpowiedź to lista obiektów ServiceEvent.
Żądanie
Metoda | Identyfikator URI żądania |
---|---|
GET | /EventsStore/Services/{serviceId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup} |
Parametry
Nazwa | Typ | Wymagane | Lokalizacja |
---|---|---|---|
serviceId |
ciąg | Tak | Ścieżka |
api-version |
ciąg | Tak | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
StartTimeUtc |
ciąg | Tak | Zapytanie |
EndTimeUtc |
ciąg | Tak | Zapytanie |
EventsTypesFilter |
ciąg | Nie | Zapytanie |
ExcludeAnalysisEvents |
boolean | Nie | Zapytanie |
SkipCorrelationLookup |
boolean | Nie | Zapytanie |
serviceId
Typ: ciąg
Wymagane: Tak
Tożsamość usługi. Ten identyfikator jest zazwyczaj pełną nazwą usługi bez schematu identyfikatora URI "fabric:".
Począwszy od wersji 6.0, nazwy hierarchiczne są rozdzielane znakiem "~".
Jeśli na przykład nazwa usługi to "fabric:/myapp/app1/svc1", tożsamość usługi będzie miała wartość "myapp~app1~svc1" w wersji 6.0+ i "myapp/app1/svc1" w poprzednich wersjach.
api-version
Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.4
Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6,4".
Wersja interfejsu API REST usługi Service Fabric jest oparta na wersji środowiska uruchomieniowego, w której wprowadzono lub zmieniono interfejs API. Środowisko uruchomieniowe usługi Service Fabric obsługuje więcej niż jedną wersję interfejsu API. Ta wersja jest najnowszą obsługiwaną wersją interfejsu API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może być inna niż ta udokumentowana w tej specyfikacji.
Ponadto środowisko uruchomieniowe akceptuje każdą wersję, która jest wyższa niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, a środowisko uruchomieniowe to 6.1, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.
timeout
Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Limit czasu serwera na potrzeby wykonywania operacji w sekundach. Ten limit czasu określa czas trwania, przez który klient chce poczekać na ukończenie żądanej operacji. Wartość domyślna tego parametru to 60 sekund.
StartTimeUtc
Typ: ciąg
Wymagane: Tak
Godzina rozpoczęcia zapytania odnośnika w formacie ISO UTC rrrr-MM-ddTHH:mm:ssZ.
EndTimeUtc
Typ: ciąg
Wymagane: Tak
Godzina zakończenia zapytania odnośnika w formacie ISO UTC rrrr-MM-ddTHH:mm:ssZ.
EventsTypesFilter
Typ: ciąg
Wymagane: Nie
Jest to ciąg rozdzielony przecinkami określający typy fabricEvents, które powinny być uwzględnione tylko w odpowiedzi.
ExcludeAnalysisEvents
Typ: wartość logiczna
Wymagane: Nie
Ten parametr wyłącza pobieranie elementu AnalysisEvents, jeśli wartość true została przekazana.
SkipCorrelationLookup
Typ: wartość logiczna
Wymagane: Nie
Ten parametr wyłącza wyszukiwanie informacji SkorelowaneEvents, jeśli wartość true została przekazana. w przeciwnym razie elementy CorrelationEvents są przetwarzane, a pole HasCorrelatedEvents w każdej usłudze FabricEvent zostaje wypełnione.
Odpowiedzi
Kod stanu HTTP | Opis | Response Schema |
---|---|---|
200 (OK) | Lista obiektów zdarzeń o typie podstawowym ServiceEvent. |
tablica elementu ServiceEvent |
Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |
Przykłady
Pobieranie zdarzeń związanych z usługą
W tym przykładzie pokazano, jak uzyskać wszystkie zdarzenia związane z usługą w określonym przedziale czasu.
Żądanie
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
200 Odpowiedź
Treść
[
{
"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
}
]