Uzyskiwanie kondycji repliki przy użyciu zasad

  • Artykuł

Pobiera kondycję repliki usługi stanowej usługi Service Fabric lub wystąpienia usługi bezstanowej przy użyciu określonych zasad.

Pobiera kondycję repliki usługi stanowej usługi Service Fabric lub wystąpienia usługi bezstanowej. Użyj parametru EventsHealthStateFilter, aby filtrować kolekcję zdarzeń kondycji zgłoszonych w klastrze na podstawie stanu kondycji. Użyj metody ApplicationHealthPolicy, aby opcjonalnie zastąpić zasady kondycji używane do oceny kondycji. Ten interfejs API używa tylko pola "ConsiderWarningAsError" w kodzie ApplicationHealthPolicy. Pozostałe pola są ignorowane podczas oceniania kondycji repliki.

Żądanie

Metoda Identyfikator URI żądania
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
partitionId ciąg (uuid) Tak Ścieżka
replicaId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
EventsHealthStateFilter liczba całkowita Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie
ApplicationHealthPolicy ApplicationHealthPolicy Nie Treść

partitionId

Typ: ciąg (uuid)
Wymagane: Tak

Tożsamość partycji.

replicaId

Typ: ciąg
Wymagane: Tak

Identyfikator repliki.

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.

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.

ApplicationHealthPolicy

Typ: ApplicationHealthPolicy
Wymagane: Nie

Opisuje zasady kondycji używane do oceny kondycji aplikacji lub jednego z jej elementów podrzędnych. Jeśli nie istnieje, ocena kondycji używa zasad kondycji z manifestu aplikacji lub domyślnych zasad kondycji.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Operacja zakończona pomyślnie zwróci kod stanu 200 i żądane informacje o kondycji repliki.
 ReplicaHealth
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 FabricError