请求头
以下 HTTP 请求头与所有请求方法 (GET ， PUT ， POST 和 DELETE) 相关，并且在所有 API 请求上都是必需的。
必需的请求头字段
| HTTP 头 | 描述 |
|---|---|
| 主机 | 指定要将请求定向到的 HMC 的因特网主机和端口号 (从客户机应用程序指定的原始 URI 获取)。 Web Services API 强制要求按 HTTP 协议的要求提供头，但不检查或使用头的值。 |
| X-API-会话 | 不透明字符串，用于提供执行此请求的 API 会话 (称为会话标识) 的密码强标识。 需要认证的所有请求都需要此头。 登录操作将开始新的 HMC 会话，并包含标识该会话的 HMC 用户的凭证。 成功认证后， Login 操作将返回要在同一会话的所有后续请求的 X-API-Session 头中使用的值。 未能在需要认证的请求上包含此头会导致状态码 403 (已禁止) ，原因码为 4。 指定无效会话标识会导致状态码 403 (已禁止) ，原因码为 5。 |
| 内容长度 | 在请求中使用时，指定请求主体的长度。 如果省略，那么将假定请求不包含主体。 |
| content-type | 在请求中使用时，指定请求中包含的请求主体的 MIME 媒体类型。 如果提供了 Content-Length 头并指定非零请求主体长度，那么此头是必需的，否则将生成状态码 400 (错误请求)。 |
| 接受 | 指定客户机应用程序为响应请求而准备接受的响应 MIME 媒体类型的列表。 在 Web Service API 支持给定操作的多种可能的响应介质类型的情况下，将为客户机与服务器之间的内容协商提供此头。 如果包含头，那么它必须允许操作支持的介质类型，否则请求将失败， HTTP 状态码为 406 (不可接受)。 |
可选请求头字段
| HTTP 头 | 描述 |
|---|---|
| X-审计-备忘录 | HMC REST Web Service 将每个使用者请求记录到其审计日志中。 审计日志使用 RFC-5424 扩展系统日志格式化进行格式化。 对于写入审计日志的每个 GET ， PUT ， POST 或 DELETE 请求，如果已指定 X-Audit-Memento 头，那么该值将放入审计日志中。 头名称将不会放入审计日志中。 |
| X-客户机相关因子 | 不透明字符串，用于提供执行此请求的 API 会话 (称为会话标识) 的密码强标识。 需要认证的所有请求都需要此头。 登录操作将开始新的 HMC 会话，并包含标识该会话的 HMC 用户的凭证。 成功认证后， Login 操作将返回要在同一会话的所有后续请求的 X-API-Session 头中使用的值。 未能在需要认证的请求上包含此头会导致状态码 403 (已禁止) ，原因码为 4。 指定无效会话标识会导致状态码 403 (已禁止) ，原因码为 5。 |
| If-Match | 提供先前接收到的 ETag 值或通配符，并根据所提供值与服务器当前已知的实际值的匹配，启用条件 PUT 或 POST 操作。 |
| 如果-无-匹配 | 提供先前接收到的 ETag 值或通配符，并基于与提供的值不匹配启用条件 PUT 或 POST 操作。 |
| X-HMC-模式-版本 | 指定模式版本。 当针对 HMC V 1.2.0与 HMC V 1.1.0 一起指定时，响应包含引入到 V 1.1.0的属性。 如果未指定模式版本，那么将返回 HMC 支持的最新版本作为响应。 |
| X-事务标识 | 由具有字母数字值的客户机代码设置时，将在日志文件中记录事务标识以进行调试。 当客户机未指定此值时， REST 服务器会自动为入局请求生成此值。 主要目的是针对单个事务标识一次性过滤各种日志，以方便调试 |