Pobieranie listy stanów wdrożenia redagowania

  • Artykuł

Pobiera listę wdrożeń redagowania utworzonych w klastrze usługi Service Fabric.

Pobiera stan wdrożeń redagowania, które zostały utworzone lub w procesie tworzenia w klastrze usługi Service Fabric. Odpowiedź zawiera nazwę, stan i inne szczegóły dotyczące wdrożeń redagowania. Jeśli lista wdrożeń nie mieści się na stronie, zostanie zwrócona jedna strona wyników, a także token kontynuacji, którego można użyć do pobrania następnej strony.

Żądanie

Metoda Identyfikator URI żądania
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
api-version ciąg Tak 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.0-preview

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0-preview".

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.

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 stanu wdrożeń redagowania w klastrze.
 PagedComposeDeploymentStatusInfoList
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 Błąd sieci szkieletowej