Pobieranie listy informacji o usłudze
Pobiera informacje o wszystkich usługach należących do aplikacji określonej przez identyfikator aplikacji.
Zwraca informacje o wszystkich usługach należących do aplikacji określonej przez identyfikator aplikacji.
Żądanie
Metoda | Identyfikator URI żądania |
---|---|
GET | /Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parametry
Nazwa | Typ | Wymagane | Lokalizacja |
---|---|---|---|
applicationId |
ciąg | Tak | Ścieżka |
ServiceTypeName |
ciąg | Nie | Zapytanie |
api-version |
ciąg | Tak | Zapytanie |
ContinuationToken |
ciąg | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
applicationId
Typ: ciąg
Wymagane: Tak
Tożsamość aplikacji. Jest to zazwyczaj 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.
ServiceTypeName
Typ: ciąg
Wymagane: Nie
Nazwa typu usługi używana do filtrowania usług do wykonywania zapytań.
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.
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.
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 usług w klastrze dla określonej aplikacji. |
PagedServiceInfoList |
Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |