Pobieranie kondycji klastra przy użyciu zasad
Pobiera kondycję klastra usługi Service Fabric przy użyciu określonych zasad.
Użyj parametru EventsHealthStateFilter, aby filtrować kolekcję zdarzeń kondycji zgłoszonych w klastrze na podstawie stanu kondycji. Podobnie użyj węzłówHealthStateFilter i ApplicationsHealthStateFilter, aby filtrować kolekcję węzłów i aplikacji zwróconych na podstawie ich zagregowanego stanu kondycji. Użyj funkcji ClusterHealthPolicies, aby zastąpić zasady kondycji używane do oceny kondycji.
Żądanie
| Metoda | Identyfikator URI żądania |
|---|---|
| POST | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parametry
| Nazwa | Typ | Wymagane | Lokalizacja |
|---|---|---|---|
api-version |
ciąg | Tak | Zapytanie |
NodesHealthStateFilter |
liczba całkowita | Nie | Zapytanie |
ApplicationsHealthStateFilter |
liczba całkowita | Nie | Zapytanie |
EventsHealthStateFilter |
liczba całkowita | Nie | Zapytanie |
ExcludeHealthStatistics |
boolean | Nie | Zapytanie |
IncludeSystemApplicationHealthStatistics |
boolean | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
ClusterHealthPolicies |
ClusterHealthPolicies | Nie | Treść |
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.
NodesHealthStateFilter
Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0
Umożliwia filtrowanie obiektów stanu kondycji węzła zwróconych w wyniku zapytania kondycji klastra 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 węzły zgodne z filtrem. Wszystkie węzły 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, zwracany jest stan kondycji węzłów 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.
ApplicationsHealthStateFilter
Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0
Umożliwia filtrowanie obiektów stanu kondycji aplikacji zwróconych w wyniku zapytania kondycji klastra na podstawie ich stanu kondycji.
Możliwe wartości tego parametru obejmują wartość całkowitą uzyskaną z elementów członkowskich lub operacji bitowych na elementach członkowskich wyliczenia HealthStateFilter. Zwracane są tylko aplikacje zgodne z filtrem.
Wszystkie aplikacje 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, zwracana jest kondycja aplikacji z wartością HealthState (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.
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.
ExcludeHealthStatistics
Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false
Wskazuje, czy statystyki kondycji powinny być zwracane w ramach wyniku zapytania. Domyślnie fałsz.
Statystyki pokazują liczbę jednostek podrzędnych w stanie kondycji Ok, Ostrzeżenie i Błąd.
IncludeSystemApplicationHealthStatistics
Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false
Wskazuje, czy statystyki kondycji powinny zawierać statystyki kondycji sieci szkieletowej:/System application health. Domyślnie fałsz.
Jeśli parametr IncludeSystemApplicationHealthStatistics ma wartość true, statystyki kondycji obejmują jednostki należące do aplikacji fabric:/System.
W przeciwnym razie wynik zapytania zawiera statystyki kondycji tylko dla aplikacji użytkowników.
Statystyki kondycji należy uwzględnić w wyniku zapytania, aby ten parametr został zastosowany.
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.
ClusterHealthPolicies
Typ: ClusterHealthPolicies
Wymagane: Nie
Opisuje zasady kondycji używane do oceny kondycji klastra.
Jeśli nie istnieje, ocena kondycji używa zasad kondycji klastra zdefiniowanych w manifeście klastra lub domyślnych zasad kondycji klastra.
Domyślnie każda aplikacja jest oceniana przy użyciu określonych zasad kondycji aplikacji zdefiniowanych w manifeście aplikacji lub domyślnych zasad kondycji, jeśli żadne zasady nie są zdefiniowane w manifeście.
Jeśli zostanie określona mapa zasad kondycji aplikacji i ma wpis dla aplikacji, określone zasady kondycji aplikacji są używane do oceny kondycji aplikacji.
Odpowiedzi
| Kod stanu HTTP | Opis | Response Schema |
|---|---|---|
| 200 (OK) | Pomyślna operacja zwróci kod stanu 200 i żądane informacje o kondycji klastra. |
ClusterHealth (Kondycja klastra) |
| Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |