5.15.1 配布物の取得(ファイルダウンロード)
- 機能
-
リクエスト行で指定した配布物(ファイル)をダウンロードします。
- 実行権限
-
なし※
- 注※
-
インテリジェント統合管理基盤へのログインに使用するログインAPIの実行権限は必要です。
- APIのバージョン
-
なし
- 形式
-
- リクエスト行
GET /download/配布物のディレクトリ名/配布物のファイル名 HTTP/1.1
- リクエストヘッダー
-
ヘッダー名
設定値
Accept
指定しないでください。
指定しても,ダウンロードするファイルがzip形式の場合は「application/zip」,gz形式の場合は「application/x-gzip」が仮定されます。
ほかのリクエストヘッダーは,APIの共通仕様と同じです。APIの共通仕様のリクエストヘッダーについては,「5.2.3 リクエスト形式」の,リクエストヘッダーの説明を参照してください。
- リクエストのメッセージボディー
-
なし
- レスポンスのメッセージボディー
-
配布物のファイルの内容
- パラメーター
-
リクエスト行に指定するパラメーターを次に示します。
項番
パラメーター
データ型
説明
1
配布物のディレクトリ名
string
配布物のディレクトリを必須で指定します。
存在しない配布物のディレクトリ名を指定した場合,配布物の取得に失敗します。
2
配布物のファイル名
string
配布物のディレクトリを必須で指定します。
存在しない配布物のファイル名を指定した場合,配布物の取得に失敗します。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します
ステータスコード
HTTPステータスコードのフレーズ
説明
200
OK
APIの処理が成功しました。
403
Forbidden
認証していません,認証情報に誤りがあります。
404
Not Found
指定した配布物が存在していません,Windows環境の場合,配布物にアクセスできません。
ただし,Windows環境の場合,配布物のファイル自体にアクセス権限がない場合,エラーにならず,数分間の無応答のあと,通信を閉じます。
ステータスコードが200の場合,レスポンスのメッセージボディーに配布物のファイルの内容を返却します。
- 注意事項
-
JP1/IM - Manager(Linux)に格納する配布物(ファイル)の要件を,次に示します。
- ■配布物のファイル
-
-
ファイルとして扱えること
-
圧縮ファイルであること(配布先がLinux環境の場合:gz形式,配布先がWindows環境の場合:zip形式)
-
ファイル名は,下記の「■配布物のファイル名と格納先のディレクトリ名の命名規則」に従うこと
-
ファイルには,次に示す権限を付与すること
権限
オーナー
グループ
-r--r--r--
root
root
-
ファイルサイズの上限は,300MBです。
-
- ■配布物の格納先として作成するディレクトリ
-
-
次に示す格納場所に,同系の配布物を格納するディレクトリを作成し,作成したディレクトリに配布物を格納すること
格納場所
/opt/jp1imm/public/download
-
ディレクトリ名は,下記に示す「■配布物のファイル名と格納先のディレクトリ名の命名規則」に従うこと
-
ディレクトリには,次の権限を付与すること
権限
オーナー
グループ
drwxr-xr-x
root
root
-
- ■配布物のファイル名と格納先のディレクトリ名の命名規則
-
<予約語>
次に示す文字列で始まるファイル名およびディレクトリ名は,予約語です。大文字・小文字は区別しません。
-
hitachi_
-
jp1_
上記の予約語は,日立製品またはJP1製品(JP1/IM - Agentを含む)が提供する機能やサービスの範囲で,ファイルを配布する場合に使用します。それ以外のユーザー独自のファイルを配布する場合には使用できません。
<使用できる文字>
ファイル名およびディレクトリ名に使用できる文字を,次に示します。
-
半角英数字
-
-(ハイフン)
-
.(ピリオド)
-
_(アンダースコア)
-
- ■配布物のファイルパス(拡張子を含む)
-
-
235文字以下であること
ファイルパスに環境変数を使用する場合,環境変数を展開したあとの配布物のファイルパス(拡張子を含む)が235文字以下であること。
-
- ■配布物(配布製品)の提供元
-
-
配布物(配布製品)の提供元は,配布物のバージョン情報を確認する方法を提供すること
JP1/IM - Agentのバージョン情報は,バージョンファイル(Version.txt)で確認できます。
JP1/IM - Agentのバージョンファイルの格納先については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「付録A.4 JP1/IM - Agent」の「(3)統合エージェントホスト(Windows)」および「(4)統合エージェントホスト(Linux)」を参照してください。
-
- 使用例
-
- リクエスト例
GET http://hostname:20703/download/im2-agent/xxx.zip