Udostępnij za pośrednictwem

Uzyskiwanie kondycji wdrożonej aplikacji przy użyciu zasad

  • Artykuł

Pobiera informacje o kondycji aplikacji wdrożonej w węźle usługi Service Fabric. przy użyciu określonych zasad.

Pobiera informacje o kondycji aplikacji wdrożonej w węźle usługi Service Fabric przy użyciu określonych zasad. Użyj klasy EventsHealthStateFilter, aby opcjonalnie filtrować kolekcję obiektów HealthEvent zgłoszonych w wdrożonej aplikacji na podstawie stanu kondycji. Użyj polecenia DeployedServicePackagesHealthStateFilter, aby opcjonalnie filtrować elementy podrzędne DeployedServicePackageHealth na podstawie stanu kondycji. Użyj zasad ApplicationHealthPolicy, aby opcjonalnie zastąpić zasady kondycji używane do oceny kondycji. Ten interfejs API używa tylko pola "ConsiderWarningAsError" elementu ApplicationHealthPolicy. Pozostałe pola są ignorowane podczas oceniania kondycji wdrożonej aplikacji.

Żądanie

Metoda Identyfikator URI żądania
POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parametry

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

nodeName

Typ: ciąg
Wymagane: Tak

Nazwa węzła.

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.

DeployedServicePackagesHealthStateFilter

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

Umożliwia filtrowanie obiektów stanu kondycji wdrożonego pakietu usługi zwróconych w wyniku wdrożonego 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. Zwracane są tylko wdrożone pakiety usług zgodne z filtrem. Wszystkie wdrożone pakiety usług są używane do oceny zagregowanego stanu kondycji wdrożonej aplikacji. 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 pakietów usług 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.

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 informacje o kondycji wdrożonej aplikacji.
 DeployedApplicationHealth
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 FabricError