Pobieranie usługi Service Health
Pobiera kondycję określonej usługi Service Fabric.
Pobiera informacje o kondycji określonej usługi. Użyj klasy EventsHealthStateFilter, aby filtrować kolekcję zdarzeń kondycji zgłoszonych w usłudze na podstawie stanu kondycji. Użyj partitionsHealthStateFilter do filtrowania kolekcji zwróconych partycji. Jeśli określisz usługę, która nie istnieje w magazynie kondycji, to żądanie zwróci błąd.
Żądanie
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | /Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parametry
| Nazwa | Typ | Wymagane | Lokalizacja |
|---|---|---|---|
serviceId |
ciąg | Tak | Ścieżka |
api-version |
ciąg | Tak | Zapytanie |
EventsHealthStateFilter |
liczba całkowita | Nie | Zapytanie |
PartitionsHealthStateFilter |
liczba całkowita | Nie | Zapytanie |
ExcludeHealthStatistics |
boolean | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | 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.0
Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0".
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. Jest to najnowsza obsługiwana wersja 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, ale jeśli środowisko uruchomieniowe ma wartość 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.
EventsHealthStateFilter
Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0
Umożliwia filtrowanie kolekcji obiektów HealthEvent zwracanych na podstawie stanu kondycji.
Możliwe wartości tego parametru obejmują wartość całkowitą jednego z następujących stanów kondycji.
Zwracane są tylko zdarzenia zgodne z filtrem. Wszystkie zdarzenia są używane do oceny zagregowanego stanu kondycji.
Jeśli nie zostanie określony, zwracane są wszystkie wpisy. Wartości stanu są wyliczaniem opartym na flagach, więc wartość może być kombinacją tych wartości uzyskanych przy użyciu operatora bitowego "OR". Jeśli na przykład podana wartość to 6, zwracane są wszystkie zdarzenia o wartości HealthState ok (2) i Ostrzeżenie (4).
- Wartość domyślna — wartość domyślna. Pasuje do dowolnego stanu kondycji. Wartość to zero.
- Brak — filtr, który nie jest zgodny z żadną wartością HealthState. Służy do zwracania żadnych wyników w danej kolekcji stanów. Wartość to 1.
- Ok — filtr zgodny z danymi wejściowymi z wartością HealthState ok. Wartość to 2.
- Ostrzeżenie — filtr zgodny z danymi wejściowymi z wartością HealthState Ostrzeżenie. Wartość to 4.
- Błąd — filtr zgodny z danymi wejściowymi z wartością HealthState Error. Wartość to 8.
- Wszystkie — filtr zgodny z danymi wejściowymi z dowolną wartością HealthState. Wartość to 65535.
PartitionsHealthStateFilter
Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0
Umożliwia filtrowanie obiektów stanu kondycji partycji zwróconych w wyniku zapytania kondycji usługi na podstawie ich stanu kondycji.
Możliwe wartości tego parametru obejmują wartość całkowitą jednego z następujących stanów kondycji.
Zwracane są tylko partycje zgodne z filtrem. Wszystkie partycje są używane do oceny zagregowanego stanu kondycji.
Jeśli nie zostanie określony, zwracane są wszystkie wpisy. Wartości stanu są wyliczaniem opartym na flagach, więc wartość może być kombinacją tych wartości uzyskanych przy użyciu operatora bitowego "OR". Jeśli na przykład podana wartość to 6, zostanie zwrócony stan kondycji partycji z wartością HealthState ok (2) i Ostrzeżenie (4).
- Wartość domyślna — wartość domyślna. Pasuje do dowolnego stanu kondycji. Wartość to zero.
- Brak — filtr, który nie jest zgodny z żadną wartością HealthState. Służy do zwracania żadnych wyników w danej kolekcji stanów. Wartość to 1.
- Ok — filtr zgodny z danymi wejściowymi z wartością HealthState ok. Wartość to 2.
- Ostrzeżenie — filtr zgodny z danymi wejściowymi z wartością HealthState Ostrzeżenie. Wartość to 4.
- Błąd — filtr zgodny z danymi wejściowymi z wartością HealthState Error. Wartość to 8.
- Wszystkie — filtr zgodny z danymi wejściowymi z dowolną wartością HealthState. Wartość to 65535.
ExcludeHealthStatistics
Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false
Wskazuje, czy statystyki kondycji powinny być zwracane w ramach wyniku zapytania. Wartość false domyślnie.
Statystyki pokazują liczbę jednostek podrzędnych w stanie kondycji Ok, Ostrzeżenie i Błąd.
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.
Odpowiedzi
| Kod stanu HTTP | Opis | Response Schema |
|---|---|---|
| 200 (OK) | Pomyślna operacja zwróci kod stanu 200 i informacje o kondycji określonej usługi. |
ServiceHealth |
| Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
Błąd sieci szkieletowej |