Udostępnij za pośrednictwem

Uzyskiwanie kondycji aplikacji przy użyciu zasad

  • Artykuł

Pobiera kondycję aplikacji usługi Service Fabric przy użyciu określonych zasad.

Pobiera kondycję aplikacji usługi Service Fabric. Użyj elementu EventsHealthStateFilter, aby filtrować kolekcję zdarzeń kondycji zgłoszonych w węźle na podstawie stanu kondycji. Użyj elementu ClusterHealthPolicies, aby zastąpić zasady kondycji używane do oceny kondycji.

Żądanie

Metoda Identyfikator URI żądania
POST /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
applicationId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
EventsHealthStateFilter liczba całkowita Nie Zapytanie
DeployedApplicationsHealthStateFilter liczba całkowita Nie Zapytanie
ServicesHealthStateFilter liczba całkowita Nie Zapytanie
ExcludeHealthStatistics boolean Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie
ApplicationHealthPolicy ApplicationHealthPolicy Nie Treść

applicationId

Typ: ciąg
Wymagane: Tak

Tożsamość aplikacji. Zazwyczaj jest to pełna nazwa aplikacji bez schematu identyfikatora URI "fabric:". Począwszy od wersji 6.0, nazwy hierarchiczne są rozdzielane znakiem "~". Jeśli na przykład nazwa aplikacji to "fabric:/myapp/app1", tożsamość aplikacji będzie miała wartość "myapp~app1" w wersji 6.0+ i "myapp/app1" 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 wszystkie wersje wyższe 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, zostaną zwrócone wszystkie wpisy. Wartości stanu to wyliczenie oparte 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 z wartością HealthState ok (2) i Ostrzeżenie (4).

  • Wartość domyślna — wartość domyślna. Pasuje do dowolnego stanu kondycji. Wartość jest równa zero.
  • Brak — filtr, który nie pasuje do żadnej wartości HealthState. Służy do zwracania żadnych wyników w danej kolekcji stanów. Wartość to 1.
  • OK — filtr pasujący do danych wejściowych z wartością HealthState ok. Wartość to 2.
  • Ostrzeżenie — filtr pasujący do danych wejściowych z wartością HealthState Ostrzeżenie. Wartość to 4.
  • Error — filtr zgodny z danymi wejściowymi z wartością HealthState Error. Wartość to 8.
  • All — filtr zgodny z danymi wejściowymi z dowolną wartością HealthState. Wartość to 65535.

DeployedApplicationsHealthStateFilter

Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0

Umożliwia filtrowanie obiektów stanu kondycji wdrożonych aplikacji zwróconych w wyniku zapytania dotyczącego kondycji aplikacji na podstawie ich stanu kondycji. Możliwe wartości tego parametru obejmują wartość całkowitą jednego z następujących stanów kondycji. Zostaną zwrócone tylko wdrożone aplikacje zgodne z filtrem. Wszystkie wdrożone aplikacje są używane do oceny zagregowanego stanu kondycji. Jeśli nie zostanie określony, zostaną zwrócone wszystkie wpisy. Wartości stanu to wyliczenie oparte 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 wdrożonych aplikacji z wartością HealthState ok (2) i Ostrzeżenie (4).

  • Wartość domyślna — wartość domyślna. Pasuje do dowolnego stanu kondycji. Wartość jest równa zero.
  • Brak — filtr, który nie pasuje do żadnej wartości HealthState. Służy do zwracania żadnych wyników w danej kolekcji stanów. Wartość to 1.
  • OK — filtr pasujący do danych wejściowych 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.

ServicesHealthStateFilter

Typ: liczba całkowita
Wymagane: Nie
Ustawienie domyślne: 0

Umożliwia filtrowanie obiektów stanu kondycji usług zwróconych w wyniku zapytania kondycji usług 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 usługi zgodne z filtrem. Wszystkie usługi 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 usług 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. Domyślnie fałsz. 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.

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) Pomyślna operacja zwróci kod stanu 200 i żądane informacje o kondycji węzła.
 ApplicationHealth
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 FabricError