Nagłówki żądania

Następujące nagłówki żądań HTTP są odpowiednie dla wszystkich metod żądań (GET, PUT, POST i DELETE) i są wymagane dla wszystkich żądań interfejsu API.

Wymagane pola nagłówka żądania

Tabela 1. Nagłówek HTTP
Nagłówek HTTP	Opis
Gospodarz	Określa host internetowy i numer portu konsoli HMC, do której kierowane jest żądanie, zgodnie z oryginalnym identyfikatorem URI określonym przez aplikację kliencką. Funkcja API Web Services wymusza, aby nagłówek był udostępniany zgodnie z wymaganiami protokołu HTTP, ale nie sprawdza ani nie używa wartości nagłówka.
X-API-Sesja	Osłonięty łańcuch udostępniający identyfikator sesji API (znany jako identyfikator sesji), w ramach którego wykonywane jest to żądanie. Ten nagłówek jest wymagany we wszystkich żądaniach, które wymagają uwierzytelniania. Operacja logowania rozpoczyna nową sesję konsoli HMC i zawiera informacje autoryzacyjne identyfikujące użytkownika konsoli HMC dla sesji. Po pomyślnym uwierzytelnieniu operacja logowania zwraca wartość, która ma być używana w nagłówku X-API-Session dla wszystkich kolejnych żądań tej samej sesji. Niedołączenie tego nagłówka do żądania wymagającego uwierzytelnienia spowoduje wyświetlenie kodu statusu 403 (Zabronione) z kodem przyczyny 4. Podanie niepoprawnego identyfikatora sesji powoduje wyświetlenie kodu statusu 403 (Zabronione) z kodem przyczyny 5.
Treść-długość	W przypadku użycia w żądaniu określa długość treści żądania. W przypadku pominięcia żądania przyjmuje się, że nie zawiera ono treści.
Typ treści	W przypadku użycia w żądaniu określa typ nośnika MIME treści żądania zawartego w żądaniu. Ten nagłówek jest wymagany, jeśli podano nagłówek Content-Length i określono niezerową długość treści żądania. W przeciwnym razie zostanie zwrócony kod statusu 400 (Bad Request).
Akceptuję	Określa listę typów nośników MIME odpowiedzi, które aplikacja kliencka jest przygotowana do akceptowania odpowiedzi na żądanie. Ten nagłówek jest udostępniany na potrzeby negocjacji treści między klientem i serwerem w przypadkach, gdy interfejs API usług Web Service obsługuje wiele możliwych typów nośników odpowiedzi dla danej operacji. Jeśli nagłówek jest dołączony, musi zezwalać na typy nośników obsługiwane przez operację, w przeciwnym razie żądanie nie powiedzie się i zostanie zwrócony kod statusu HTTP 406 (Nieakceptowalne).

Opcjonalne pola nagłówka żądania

Tabela 2. Nagłówek HTTP
Nagłówek HTTP	Opis
X-Audyt-Memento	Usługi WWW REST konsoli HMC rejestrują każde żądanie konsumenta w swoim dzienniku kontroli. Dziennik kontroli jest formatowany przy użyciu rozszerzonego formatowania syslog RFC-5424 . Dla każdego żądania GET, PUT, POST lub DELETE zapisanego w dzienniku kontroli, jeśli określono nagłówek X-Audit-Memento, wartość ta zostanie umieszczona w dzienniku kontroli. Nazwa nagłówka nie zostanie umieszczona w dzienniku kontroli.
X-Klient-Korelator	Osłonięty łańcuch udostępniający identyfikator sesji API (znany jako identyfikator sesji), w ramach którego wykonywane jest to żądanie. Ten nagłówek jest wymagany we wszystkich żądaniach, które wymagają uwierzytelniania. Operacja logowania rozpoczyna nową sesję konsoli HMC i zawiera informacje autoryzacyjne identyfikujące użytkownika konsoli HMC dla sesji. Po pomyślnym uwierzytelnieniu operacja logowania zwraca wartość, która ma być używana w nagłówku X-API-Session dla wszystkich kolejnych żądań tej samej sesji. Niedołączenie tego nagłówka do żądania wymagającego uwierzytelnienia spowoduje wyświetlenie kodu statusu 403 (Zabronione) z kodem przyczyny 4. Podanie niepoprawnego identyfikatora sesji powoduje wyświetlenie kodu statusu 403 (Zabronione) z kodem przyczyny 5.
Jeśli-Dopasuj	Dostarcza poprzednio odebraną wartość ETag lub znak wieloznaczny i włącza warunkowe operacje PUT lub POST na podstawie zgodności podanej wartości z bieżącą wartością aktualnie znaną serwerowi.
Jeśli-Brak-Dopasuj	Dostarcza poprzednią odebraną wartość ETag lub znak wieloznaczny i włącza warunkowe operacje PUT lub POST na podstawie braku zgodności z podaną wartością.
X-HMC-wersja-schematu	Określa wersję schematu. W przypadku użycia konsoli HMC w wersji 1.1.0 z wersją 1.2.0, odpowiedź zawiera atrybuty wprowadzone do wersji 1.1.0. Jeśli wersja schematu nie zostanie podana, jako odpowiedź zwracana jest najnowsza wersja obsługiwana przez konsolę HMC.
X-ID-transakcji	W przypadku ustawienia przez kod klienta wartości alfanumerycznej, identyfikator transakcji jest rejestrowany w plikach dziennika na potrzeby debugowania. Jeśli klient nie określa tej wartości, serwer REST automatycznie generuje tę wartość dla żądania przychodzącego. Głównym celem jest filtrowanie różnych dzienników jednocześnie dla pojedynczego identyfikatora transakcji, aby ułatwić debugowanie.