Wywołaj polecenie infrastruktury
Wywołuje polecenie administracyjne dla danego wystąpienia usługi infrastruktury.
W przypadku klastrów, które mają skonfigurowane co najmniej jedno wystąpienie usługi infrastruktury, ten interfejs API umożliwia wysyłanie poleceń specyficznych dla infrastruktury do określonego wystąpienia usługi infrastruktury.
Dostępne polecenia i odpowiadające im formaty odpowiedzi różnią się w zależności od infrastruktury, na której działa klaster.
Ten interfejs API obsługuje platformę usługi Service Fabric; nie jest przeznaczony do użycia bezpośrednio z kodu.
Żądanie
| Metoda | Identyfikator URI żądania |
|---|---|
| POST | /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout} |
Parametry
| Nazwa | Typ | Wymagane | Lokalizacja |
|---|---|---|---|
api-version |
ciąg | Tak | Zapytanie |
Command |
ciąg | Tak | Zapytanie |
ServiceId |
ciąg | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
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.
Command
Typ: ciąg
Wymagane: Tak
Tekst polecenia do wywołania. Zawartość polecenia jest specyficzna dla infrastruktury.
ServiceId
Typ: ciąg
Wymagane: Nie
Tożsamość usługi infrastruktury. Jest to pełna nazwa usługi infrastruktury bez schematu identyfikatora URI "fabric:". Ten parametr jest wymagany tylko dla klastra z więcej niż jednym wystąpieniem usługi infrastruktury.
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) | Odpowiedź z usługi infrastruktury. Format odpowiedzi jest strumieniem JSON. Zawartość odpowiedzi zależy od tego, które polecenie zostało wydane. |
ciąg |
| Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |