Udostępnij za pośrednictwem

Pobieranie listy informacji o wdrożonej aplikacji

  • Artykuł

Pobiera listę aplikacji wdrożonych w węźle usługi Service Fabric.

Pobiera listę aplikacji wdrożonych w węźle usługi Service Fabric. Wyniki nie zawierają informacji o wdrożonych aplikacjach systemowych, chyba że jawnie odpytują o identyfikator. 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?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parametry

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

nodeName

Typ: ciąg
Wymagane: Tak

Nazwa węzła.

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.

ContinuationToken

Typ: ciąg
Wymagane: Nie

Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z niepustą wartością jest uwzględniany w odpowiedzi interfejsu API, gdy wyniki z systemu nie mieszczą się w jednej odpowiedzi. Po przekazaniu tej wartości do następnego wywołania interfejsu API interfejs API zwraca następny zestaw wyników. Jeśli nie ma dalszych wyników, token kontynuacji nie zawiera wartości. Wartość tego parametru nie powinna być zakodowana w adresie URL.

MaxResults

Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 0
InclusiveMinimum: 0

Maksymalna liczba wyników do zwrócenia w ramach stronicowanych zapytań. Ten parametr definiuje górną granicę liczby zwróconych wyników. Zwrócone wyniki mogą być mniejsze niż określone maksymalne wyniki, jeśli nie mieszczą się w komunikacie zgodnie z maksymalnymi ograniczeniami rozmiaru komunikatu zdefiniowanymi w konfiguracji. Jeśli ten parametr ma wartość zero lub nie zostanie określony, stronicowane zapytanie zawiera jak najwięcej wyników, które mieszczą się w komunikacie zwrotnym.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Pomyślna operacja zwróci kod stanu 200 i listę wdrożonych informacji o aplikacji.
 PagedDeployedApplicationInfoList
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej

Przykłady

Ogranicz maksymalne wyniki

W tym przykładzie pokazano, jak określić liczbę aplikacji zwracanych przez zapytanie podczas uzyskiwania informacji o aplikacjach wdrożonych w określonym węźle. Liczba wyników na stronie jest ograniczona do maksymalnie 2 przy użyciu parametru MaxResult. Stan kondycji nie jest żądany w tym przykładzie, więc zwrócony stan kondycji będzie nieznany.

Żądanie

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

Odpowiedź 200

Treść
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Strona używająca tokenu kontynuacji

W tym przykładzie przedstawiono funkcje stronicowania dostępne podczas uzyskiwania informacji o aplikacjach wdrożonych w określonym węźle. W tym przykładzie użyto parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania; w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostałe wyniki i pusty ciąg ContinuationToken. Pusty ciąg ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.

Żądanie

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

200 Odpowiedź

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Uwzględnij stan kondycji w wyniku

W tym przykładzie pokazano, jak uwzględnić stan kondycji każdej wdrożonej aplikacji podczas uzyskiwania informacji o aplikacjach wdrożonych w określonym węźle.

Żądanie

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

200 Odpowiedź

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}