Tuning Manager APIリファレンスガイド

[目次][索引][前へ][次へ]


2.3.2 ヘッダー

指定可能なヘッダーを次の表に示します。なお,ヘッダーの種類の名称は大文字,小文字を区別しません。

表2-5 Tuning Managerシリーズで指定可能なヘッダー

ヘッダーの種類 説明 指定要否
Authorization ユーザー認証に使用します。
認証についての詳細は,「2.4 セキュリティと認証」を参照してください。
必須
Accept 受信可能なレスポンスデータのメディアタイプを指定します。 Acceptヘッダー自体を省略する場合だけ省略できます。
省略した場合は,すべてのメディアタイプが受信可能であることを表す「*」が指定されたと見なします。

注意
Tuning Manager APIでは,Acceptヘッダーのメディアタイプを個別に指定する場合,「application/json」の指定を必須とし,さらにメタデータ取得の際は「application/schema+json」を,パフォーマンスデータを取得する際は「text/csv」を指定する必要があります。
Accept-Encoding レスポンスを圧縮転送する場合に指定します。
圧縮転送についての詳細は,「2.5 圧縮転送」を参照してください。
任意
Content-Type リクエストボディのメディアタイプを指定します。 GETメソッド使用時は指定不要です。指定した場合は無視されます。
PUTメソッドおよびPOSTメソッド使用時は,「application/json」の指定が必須です。
Content-Length リクエストボディのサイズを10進数で指定します(単位:バイト)。 GETメソッド使用時は任意です。ただし指定する場合のサイズは0とします。0以外を指定した場合には,Webサーバの仕様に従って処理されます。
PUTメソッドおよびPOSTメソッド使用時は,Content-Length, または Transfer-Encodingのどちらかの指定が必須です。
Transfer-Encoding リクエストボディの転送コーディングを指定します。
HTTP1.1では「chunked」を指定できます。
GETメソッド使用時は任意です。ただし指定する場合のサイズは0とします。
PUTメソッドおよびPOSTメソッド使用時は,Content-Length, または Transfer-Encodingのどちらかの指定が必須です。

Acceptヘッダーについては,複数行で指定した場合でも1行で指定した場合と同じと見なされます。例を次に示します。

ヘッダーを複数行で指定した場合の例
Accept: application/json
Accept: text/csv
Accept: application/xml

ヘッダーを1行で指定した場合の例
Accept: application/json, text/csv, application/xml

また,Accept以外のヘッダーは,1種類のヘッダーを複数行で指定した場合と1行で指定した場合とは同じと見なされません。Accept以外のヘッダーを複数行で指定した場合の動作を次の表に示します。

表2-6 複数行で指定した場合でも1行指定と同じと見なされないヘッダー

ヘッダーの種類 複数指定時の動作
Authorization 最初に指定したヘッダーを優先します。
Accept-Encoding gzipidentityの順で優先します。
Content-Type 最初に指定したヘッダーを優先します。
Content-Length Webサーバの動作に従います。
Transfer-Encoding Webサーバの動作に従います。
Content-LengthおよびTransfer-Encoding これらの2種類のヘッダーが指定された場合,Transfer-Encodingが優先されます。

[目次] [前へ] [次へ]


[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.