Pobieranie listy informacji o typie aplikacji według nazwy
Pobiera listę typów aplikacji w klastrze usługi Service Fabric pasujących dokładnie do określonej nazwy.
Zwraca informacje o typach aplikacji, które są aprowizowane lub w procesie aprowizacji w klastrze usługi Service Fabric. Są to typy aplikacji, których nazwa jest zgodna dokładnie z określonym parametrem i które są zgodne z podanymi parametrami zapytania. Zwracane są wszystkie wersje typu aplikacji pasujące do nazwy typu aplikacji, a każda wersja jest zwracana jako jeden typ aplikacji. Odpowiedź zawiera nazwę, wersję, stan i inne szczegóły dotyczące typu aplikacji. Jest to zapytanie stronicowane, co oznacza, że jeśli nie wszystkie typy aplikacji mieszczą się na stronie, zwracana jest jedna strona wyników, a także token kontynuacji, który może służyć do pobrania następnej strony. Jeśli na przykład istnieje 10 typów aplikacji, ale strona pasuje tylko do pierwszych trzech typów aplikacji lub jeśli maksymalna liczba wyników zostanie ustawiona na 3, zostanie zwrócona trzy. Aby uzyskać dostęp do pozostałych wyników, pobierz kolejne strony przy użyciu zwróconego tokenu kontynuacji w następnym zapytaniu. Pusty token kontynuacji jest zwracany, jeśli nie ma żadnych kolejnych stron.
Żądanie
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parametry
| Nazwa | Typ | Wymagane | Lokalizacja |
|---|---|---|---|
applicationTypeName |
ciąg | Tak | Ścieżka |
api-version |
ciąg | Tak | Zapytanie |
ApplicationTypeVersion |
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 |
applicationTypeName
Typ: ciąg
Wymagane: Tak
Nazwa typu aplikacji.
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 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.
ApplicationTypeVersion
Typ: ciąg
Wymagane: Nie
Wersja 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 typów aplikacji w klastrze. |
PagedApplicationTypeInfoList |
| Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |