2.6　リクエストヘッダ

Accept

任意

レスポンスのメディアタイプを指定するヘッダです。

*/* (json)

デフォルト値：*/* (json)

Content-Type

任意

リクエストボディのメディアタイプを指定するヘッダです。

リクエストボディを指定する場合にContent-Typeヘッダを指定できます。リクエストボディがない場合は指定しても無視されます。

application/json

デフォルト値：application/json

Content-Length

任意

リクエストボディのサイズを指定するヘッダです。

リクエストボディを指定する場合にContent-Length ヘッダを指定できます。クライアントソフトウェアの仕様によっては、自動的に付与されます。

バイト単位で指定します。

デフォルト値：なし

Authorization

必須

認証情報を指定するヘッダです。

バージョン情報の取得のAPIおよびストレージシステムの一覧取得のAPIの場合は、指定する必要はありません。

REST APIを使用するときは、下記のとおり認証方法を使い分けてください。

• ストレージシステムの登録：ユーザIDとパスワードによる認証
• セッションの生成：ユーザIDとパスワードによる認証
• 上記以外の操作：セッションによる認証

デフォルト値：なし

Remote-Authorization

必須

（右記のオブジェクトタイプを対象としたAPIの場合）

次の形式で指定します。

Session ＜トークン＞

リモートストレージシステムで生成したセッションのトークンを指定してください。^※

デフォルト値：なし

Response-Max-Wait

任意

非同期処理のAPIを発行する場合に、レスポンスを返すまでの最大待ち時間を指定するヘッダです。REST APIサーバがAPIを受け付けた時点から、指定した時間が経過するとレスポンスが返ります。

最大待ち時間が経過する前に処理が完了した場合は、その時点でレスポンスが返ります。

レスポンスを受け取るまでの時間は、ネットワークの状況やREST APIサーバの負荷などの影響を受けるため、指定した最大待ち時間を超えることがあります。最大待ち時間は、これらの影響を考慮して指定してください。

0～1800の整数

単位：秒

デフォルト値：なし

Response-Job-Status

任意

非同期処理のAPIを発行する場合に、レスポンスを返してほしいジョブの状態を指定するヘッダです。指定した状態にジョブが遷移した時点またはエラー終了した時点でレスポンスが返ります。

次のどちらかの形式で指定します。

＜ジョブのステータス＞;

または

＜ジョブのステータス＞; Job-State=＜ジョブの状態＞

デフォルト値：なし

Job-Mode-Wait-Configuration-Change

任意

ペアの操作で、非同期処理のAPIを発行する場合に、ジョブのステータスをCompletedにするタイミングを指定するヘッダです。

次の条件を満たすAPIで使用します。

次のどちらかを指定します。

NoWaitを指定すると、ジョブのステータスをCompletedにして、データのコピーを継続します。データのコピーが完了したかどうかは、対象のリソースの状態を取得して確認します。

デフォルト値：Wait