Udostępnij za pośrednictwem

Pobieranie listy informacji o aplikacji

  • Artykuł

Pobiera listę aplikacji utworzonych w klastrze usługi Service Fabric, które pasują do określonych filtrów.

Pobiera informacje o aplikacjach, które zostały utworzone lub w procesie tworzenia w klastrze usługi Service Fabric i są zgodne z określonymi filtrami. Odpowiedź zawiera nazwę, typ, stan, parametry i inne szczegóły dotyczące aplikacji. Jeśli aplikacje nie mieszczą się na stronie, zwracana jest jedna strona wyników, a także token kontynuacji, którego można użyć do pobrania następnej strony. Nie można jednocześnie określić filtrów ApplicationTypeName i ApplicationDefinitionKindFilter.

Żądanie

Metoda Identyfikator URI żądania
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
api-version ciąg Tak Zapytanie
ApplicationDefinitionKindFilter liczba całkowita Nie Zapytanie
ApplicationTypeName ciąg Nie Zapytanie
ExcludeApplicationParameters boolean Nie Zapytanie
ContinuationToken ciąg Nie Zapytanie
MaxResults liczba całkowita (int64) Nie Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie

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 każdą wersję, która jest wyższa 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.

ApplicationDefinitionKindFilter

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

Służy do filtrowania elementu ApplicationDefinitionKind, który jest mechanizmem używanym do definiowania aplikacji usługi Service Fabric.

  • Default — wartość domyślna, która wykonuje tę samą funkcję co wybranie pozycji "Wszystkie". Wartość to 0.
  • Wszystkie — filtr zgodny z danymi wejściowymi z dowolną wartością ApplicationDefinitionKind. Wartość to 65535.
  • ServiceFabricApplicationDescription — filtr zgodny z wartością ApplicationDefinitionKind ServiceFabricApplicationDescription. Wartość to 1.
  • Compose — filtr zgodny z danymi wejściowymi za pomocą wartości ApplicationDefinitionKind Compose. Wartość to 2.

ApplicationTypeName

Typ: ciąg
Wymagane: Nie

Nazwa typu aplikacji używana do filtrowania aplikacji do wykonywania zapytań. Ta wartość nie powinna zawierać wersji typu aplikacji.

ExcludeApplicationParameters

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

Flaga określająca, czy parametry aplikacji zostaną wykluczone z wyniku.

ContinuationToken

Typ: ciąg
Wymagane: Nie

Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z wartością niepustą 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 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 pod adresem URL.

MaxResults

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

Maksymalna liczba wyników, które mają zostać zwrócone 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 komunikatów zdefiniowanymi w konfiguracji. Jeśli ten parametr ma wartość zero lub nie został określony, stronicowane zapytanie zawiera jak najwięcej wyników, które można dopasować do komunikatu zwracanego.

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.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Lista aplikacji utworzonych w klastrze.
 PagedApplicationInfoList
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 uzyskać informacje o aplikacjach w klastrze. Liczba wyników na stronie jest ograniczona do maksymalnie dwóch przy użyciu parametru MaxResult.

Żądanie

GET http://localhost:19080/Applications?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",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Strona używająca tokenu kontynuacji

W tym przykładzie pokazano, jak stronicować informacje o aplikacjach w klastrze przy użyciu parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania, w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostały jeden wynik i pusty token ContinuationToken. Pusty token ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.

Żądanie

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Odpowiedź 200

Treść
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}