Pobieranie opisu usługi

Pobiera opis istniejącej usługi Service Fabric.

Pobiera opis istniejącej usługi Service Fabric. Aby można było uzyskać jego opis, należy utworzyć usługę.

Żądanie

Metoda	Identyfikator URI żądania
GET	/Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parametry

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

---

serviceId

Typ: ciąg
Wymagane: Tak

Tożsamość usługi. Ten identyfikator jest zazwyczaj pełną nazwą usługi bez schematu identyfikatora URI "fabric:". Począwszy od wersji 6.0, nazwy hierarchiczne są rozdzielane znakiem "~". Jeśli na przykład nazwa usługi to "fabric:/myapp/app1/svc1", tożsamość usługi będzie miała wartość "myapp~app1~svc1" w wersji 6.0+ i "myapp/app1/svc1" w poprzednich wersjach.

---

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.

---

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)	Pomyślna operacja zwróci kod stanu 200.	ServiceDescription
Wszystkie inne kody stanu	Szczegółowa odpowiedź na błąd.	FabricError