Udostępnij za pośrednictwem

Uzyskiwanie informacji o wdrożonej aplikacji

  • Artykuł

Pobiera informacje o aplikacji wdrożonej w węźle usługi Service Fabric.

To zapytanie zwraca informacje o aplikacji systemowej, jeśli podany identyfikator aplikacji jest przeznaczony dla aplikacji systemowej. Wyniki obejmują wdrożone aplikacje w stanach aktywnego, aktywowania i pobierania. To zapytanie wymaga, aby nazwa węzła odpowiadała węzłowi w klastrze. Zapytanie kończy się niepowodzeniem, jeśli podana nazwa węzła nie wskazuje żadnych aktywnych węzłów usługi Service Fabric w klastrze.

Żądanie

Metoda Identyfikator URI żądania
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parametry

Nazwa Typ Wymagane Lokalizacja
nodeName ciąg Tak Ścieżka
applicationId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie
IncludeHealthState boolean Nie Zapytanie

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.1

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.1".

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.

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.

IncludeHealthState

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

Uwzględnij stan kondycji jednostki. Jeśli ten parametr ma wartość false lub nie zostanie określony, zwracany stan kondycji to "Nieznany". Po ustawieniu wartości true zapytanie przechodzi równolegle do węzła i usługi systemu kondycji przed scaleniem wyników. W związku z tym zapytanie jest droższe i może trwać dłużej.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Pomyślna operacja zwróci kod stanu 200 i informacje o wdrożonej aplikacji.
 DeployedApplicationInfo
204 (NoContent) Pusta odpowiedź jest zwracana, jeśli określona aplikacja nie jest wdrożona w węźle.
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej

Przykłady

Pobieranie określonej wdrożonej aplikacji według identyfikatora aplikacji i uwzględnianie stanu kondycji w wyniku

W tym przykładzie pokazano, jak uzyskać informacje o aplikacji wdrożonej w określonym węźle przy użyciu identyfikatora aplikacji. Jeśli aplikacja zostanie znaleziona, zostanie zwrócona informacja o kodzie stanu 200. Zostanie zwrócona pusta odpowiedź z kodem stanu 204, jeśli określona aplikacja nie zostanie wdrożona w węźle.

Żądanie

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

Odpowiedź 200

Treść
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Odpowiedź 204

Treść

Treść odpowiedzi jest pusta.