要求ヘッダー
以下の HTTP 要求ヘッダーは、すべての要求メソッド (GET、PUT、POST、および DELETE) に関連し、すべての API 要求で必要です。
必須の要求ヘッダー・フィールド
| HTTP ヘッダー | 説明 |
|---|---|
| ホスト | クライアント・アプリケーションによって指定された元の URI から取得された、要求の送信先の HMC のインターネット・ホストおよびポート番号を指定します。 Web Services API は、HTTP プロトコルによって要求されたとおりにヘッダーが提供されることを強制しますが、ヘッダーの値を検査したり使用したりすることはしません。 |
| X-API-セッション | この要求が実行される API セッションの暗号的に強力な ID (セッション ID と呼ばれます) を提供する不透明なストリング。 このヘッダーは、認証を必要とするすべての要求で必要です。 ログイン操作により、新規 HMC セッションが開始されます。この操作には、セッションの HMC ユーザーを識別する資格情報が含まれます。 認証が成功すると、ログイン操作は、同じセッションの後続のすべての要求に対して X-API-Session ヘッダーで使用される値を返します。 認証を必要とする要求にこのヘッダーを含めないと、状況コード 403 (禁止)、理由コード 4 になります。 無効なセッション ID を指定すると、状況コード 403 (禁止) と理由コード 5 が返されます。 |
| Content-Length | 要求で使用される場合、要求本体の長さを指定します。 省略すると、要求に本体が含まれていないと想定されます。 |
| コンテンツ・タイプ | 要求で使用される場合、要求に含まれる要求本体の MIME メディア・タイプを指定します。 Content-Length ヘッダーが提供され、ゼロ以外の要求本体の長さを指定する場合、このヘッダーは必須です。それ以外の場合は、状況コード 400 (Bad Request) が返されます。 |
| 同意する | クライアント・アプリケーションが要求に対する応答として受け入れる準備ができている応答 MIME メディア・タイプのリストを指定します。 このヘッダーは、Web サービス API が特定の操作に対して複数の可能な応答メディア・タイプをサポートする場合に、クライアントとサーバーの間のコンテンツ・ネゴシエーション用に提供されます。 ヘッダーが組み込まれている場合は、操作がサポートするメディア・タイプが許可されている必要があります。許可されていない場合、要求は HTTP 状況コード 406 (受け入れ不能) で失敗します。 |
オプションの要求ヘッダー・フィールド
| HTTP ヘッダー | 説明 |
|---|---|
| X-監査-Memento | HMC REST Web サービスは、各コンシューマー要求を監査ログに記録します。 監査ログは、 RFC-5424 拡張 syslog フォーマットを使用してフォーマット設定されます。 監査ログに書き込まれる GET、PUT、POST、または DELETE 要求ごとに、X-Audit-Memento ヘッダーが指定されている場合は、その値が監査ログに入れられます。 ヘッダー名は監査ログに入れられません。 |
| X-クライアント-相関関係子 | この要求が実行される API セッションの暗号的に強力な ID (セッション ID と呼ばれます) を提供する不透明なストリング。 このヘッダーは、認証を必要とするすべての要求で必要です。 ログイン操作により、新規 HMC セッションが開始されます。この操作には、セッションの HMC ユーザーを識別する資格情報が含まれます。 認証が成功すると、ログイン操作は、同じセッションの後続のすべての要求に対して X-API-Session ヘッダーで使用される値を返します。 認証を必要とする要求にこのヘッダーを含めないと、状況コード 403 (禁止)、理由コード 4 になります。 無効なセッション ID を指定すると、状況コード 403 (禁止) と理由コード 5 が返されます。 |
| 一致する場合 | 以前に受信した ETag 値またはワイルドカードを指定し、指定された値と現在サーバーに認識されている実際の値との一致に基づいて、条件付き PUT 操作または POST 操作を有効にします。 |
| If-None-Match | 以前に受信した ETag 値またはワイルドカードを指定し、指定された値と一致しないことに基づいて条件付き PUT または POST 操作を有効にします。 |
| X-HMC-スキーマ-バージョン | スキーマ・バージョンを指定します。 HMC バージョン 1.2.0に対して HMC バージョン 1.1.0 で指定された場合、応答には、バージョン 1.1.0までに導入された属性が含まれます。 スキーマ・バージョンが指定されていない場合、HMC によってサポートされる最新バージョンが応答として返されます。 |
| X-トランザクション ID | クライアント・コードによって英数字の値を使用して設定された場合、トランザクション ID はデバッグのためにログ・ファイルに記録されます。 クライアントがこの値を指定していない場合、REST サーバーは着信要求に対してこの値を自動生成します。 主な目的は、デバッグを容易にするために、単一のトランザクション ID についてさまざまなログを一度にフィルタリングすることです。 |