Share via

Raport Kondycja wdrożonego pakietu usługi

  • Artykuł

Wysyła raport dotyczący kondycji wdrożonego pakietu usługi Service Fabric.

Zgłasza stan kondycji pakietu usługi aplikacji wdrożonej w węźle usługi Service Fabric. Raport musi zawierać informacje o źródle raportu o kondycji i właściwości, na której jest raportowany. Raport jest wysyłany do usługi bramy usługi Service Fabric, która jest przekazywana do magazynu kondycji. Raport może zostać zaakceptowany przez bramę, ale odrzucony przez magazyn kondycji po dodatkowej weryfikacji. Na przykład magazyn kondycji może odrzucić raport z powodu nieprawidłowego parametru, takiego jak nieaktualny numer sekwencji. Aby sprawdzić, czy raport został zastosowany w magazynie kondycji, uzyskaj kondycję wdrożonego pakietu usługi i sprawdź, czy raport jest wyświetlany w sekcji HealthEvents.

Żądanie

Metoda Identyfikator URI żądania
POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
nodeName ciąg Tak Ścieżka
applicationId ciąg Tak Ścieżka
servicePackageName ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
Immediate boolean Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie
HealthInformation HealthInformation Tak 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.

servicePackageName

Typ: ciąg
Wymagane: Tak

Nazwa pakietu usługi.

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.

Immediate

Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false

Flaga wskazująca, czy raport powinien zostać wysłany natychmiast. Raport o kondycji jest wysyłany do aplikacji bramy usługi Service Fabric, która przekazuje dane do magazynu kondycji. Jeśli ustawienie Natychmiastowe ma wartość true, raport jest wysyłany natychmiast z usługi HTTP Gateway do magazynu kondycji, niezależnie od ustawień klienta sieci szkieletowej używanych przez aplikację usługi HTTP Gateway. Jest to przydatne w przypadku krytycznych raportów, które powinny być wysyłane tak szybko, jak to możliwe. W zależności od czasu i innych warunków wysyłanie raportu może nadal zakończyć się niepowodzeniem, na przykład jeśli brama HTTP jest zamknięta lub komunikat nie dociera do bramy. Jeśli ustawienie Natychmiastowe ma wartość false, raport jest wysyłany na podstawie ustawień klienta kondycji z bramy HTTP. W związku z tym zostanie ona wsadowa zgodnie z konfiguracją HealthReportSendInterval. Jest to zalecane ustawienie, ponieważ umożliwia klientowi kondycji optymalizowanie komunikatów raportowania kondycji do magazynu kondycji oraz przetwarzania raportów o kondycji. Domyślnie raporty nie są wysyłane natychmiast.

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.

HealthInformation

Typ: HealthInformation
Wymagane: Tak

Opisuje informacje o kondycji raportu kondycji. Te informacje muszą być obecne we wszystkich raportach dotyczących kondycji wysyłanych do menedżera kondycji.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Pomyślna operacja zwróci kod stanu 200.
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej