요청 헤더
다음 HTTP 요청 헤더는 모든 요청 메소드 (GET, PUT, POST및 DELETE) 와 관련되며 모든 API 요청에 필요합니다.
필수 요청 헤더 필드
| HTTP 헤더 | 설명 |
|---|---|
| 호스트 | 클라이언트 애플리케이션이 지정한 원래 URI에서 얻은 대로 요청이 지정되는 HMC의 인터넷 호스트 및 포트 번호를 지정합니다. Web Services API는 헤더가 HTTP 프로토콜에 필요한 대로 제공되도록 강제 실행하지만 헤더의 값을 확인하거나 사용하지 않습니다. |
| X-API-세션 | 이 요청이 실행되는 API 세션 (세션 ID라고 함) 의 암호적으로 강력한 ID를 제공하는 오파크 문자열입니다. 이 헤더는 인증이 필요한 모든 요청에 필요합니다. 로그인 조작은 새 HMC 세션을 시작하고 세션에 대한 HMC 사용자를 식별하는 신임 정보를 포함합니다. 인증에 성공하면 로그인 조작은 동일한 세션의 모든 후속 요청에 대해 X-API-Session 헤더에서 사용될 값을 리턴합니다. 인증이 필요한 요청에 이 헤더를 포함시키지 못하면 이유 코드 4와 함께 상태 코드 403 (금지됨) 이 발생합니다. 올바르지 않은 세션 ID를 지정하면 이유 코드 5와 함께 상태 코드 403 (금지됨) 이 발생합니다. |
| 내용 길이 | 요청에서 사용되는 경우 요청 본문의 길이를 지정합니다. 생략된 경우 요청은 본문을 포함하지 않는 것으로 가정됩니다. |
| content-type | 요청에 사용되는 경우 요청에 포함된 요청 본문의 MIME 매체 유형을 지정합니다. 이 헤더는 Content-Length 헤더가 제공되고 0이 아닌 요청 본문 길이를 지정하는 경우에 필요합니다. 그렇지 않으면 상태 코드 400 (잘못된 요청) 이 발생합니다. |
| 승인 | 클라이언트 애플리케이션이 요청에 대한 응답을 승인할 준비가 된 응답 MIME 매체 유형의 목록을 지정합니다. 이 헤더는 웹 서비스 API가 제공된 조작에 대해 가능한 여러 응답 매체 유형을 지원하는 경우 클라이언트와 서버 간의 컨텐츠 조정을 위해 제공됩니다. 헤더가 포함되면 조작이 지원하는 매체 유형을 허용해야 합니다. 그렇지 않으면 HTTP 상태 코드 406 (허용할 수 없음) 으로 요청이 실패합니다. |
선택적 요청 헤더 필드
| HTTP 헤더 | 설명 |
|---|---|
| X-감사-메멘토 | HMC REST웹 서비스는 각 이용자 요청을 해당 감사 로그에 로그합니다. 감사 로그는 RFC-5424 확장 syslog 형식화를 사용하여 형식화됩니다. 감사 로그에 기록되는 각 GET, PUT, POST 또는 DELETE 요청에 대해 X-Audit-Memento 헤더가 지정된 경우 해당 값이 감사 로그에 배치됩니다. 헤더 이름은 감사 로그에 배치되지 않습니다. |
| X-클라이언트-상관자 | 이 요청이 실행되는 API 세션 (세션 ID라고 함) 의 암호적으로 강력한 ID를 제공하는 오파크 문자열입니다. 이 헤더는 인증이 필요한 모든 요청에 필요합니다. 로그인 조작은 새 HMC 세션을 시작하고 세션에 대한 HMC 사용자를 식별하는 신임 정보를 포함합니다. 인증에 성공하면 로그인 조작은 동일한 세션의 모든 후속 요청에 대해 X-API-Session 헤더에서 사용될 값을 리턴합니다. 인증이 필요한 요청에 이 헤더를 포함시키지 못하면 이유 코드 4와 함께 상태 코드 403 (금지됨) 이 발생합니다. 올바르지 않은 세션 ID를 지정하면 이유 코드 5와 함께 상태 코드 403 (금지됨) 이 발생합니다. |
| If-일치 | 이전에 수신된 ETag값 또는 와일드카드를 제공하고 현재 서버에 알려진 실제 값과 제공된 값의 일치를 기반으로 조건부 PUT 또는 POST 조작을 사용으로 설정합니다. |
| If-None-일치 | 이전에 수신된 ETag값 또는 와일드카드를 제공하고 제공된 값과 일치하지 않는 조건 PUT 또는 POST 조작을 사용합니다. |
| X-HMC-스키마-버전 | 스키마 버전을 지정합니다. HMC 버전 1.2.0에 대해 HMC 버전 1.1.0 으로 지정된 경우, 응답에는 버전 1.1.0까지 도입된 속성이 포함됩니다. 스키마 버전을 지정하지 않으면 HMC에서 지원하는 최신 버전이 응답으로 리턴됩니다. |
| X-트랜잭션-ID | 클라이언트 코드에 의해 영숫자 값으로 설정되면 트랜잭션 ID가 디버깅을 위해 로그 파일에 로그됩니다. 클라이언트가 이 값을 지정하지 않으면 REST 서버가 수신 요청에 대해 이 값을 자동으로 생성합니다. 기본 목적은 디버깅을 용이하게 하기 위해 단일 트랜잭션 ID에 대해 한 번에 다양한 로그를 필터링하는 것입니다. |