5.15.1 Get distribution (File download)

Description

Download the distribution (file) specified in the request line.

Execution permissions

None^#

#: You must have execute permissions for the Login API used to log in to the Intelligent Integrated Management Base.

API version

None

Format

Request line

GET /download/distribution-directory-name/distribution-file-name HTTP/1.1

Request header

Header name	Setting value
Accept	Do not specify it. Even if specified, "`application/zip`" is assumed if the file to be downloaded is in zip format, and "`application/x-gzip`" is assumed if the file to be downloaded is in gz format.

Header name

Setting value

Do not specify it.

Even if specified, "application/zip" is assumed if the file to be downloaded is in zip format, and "application/x-gzip" is assumed if the file to be downloaded is in gz format.

If message body of the request is in JSON format, the other request headers are the same as Common spec of API. For the request header of Common spec of API, see the explanation of the request header in 5.2.3 Request format.

Request message body

None

Response message body

Contents of the distribution's files

Parameters

Here are the parameters that you specify for the request line:

No.	Parameters	Data type	Description
1	Distribution directory name	string	Specify the distribution directory as required. If you specify a directory name for a distribution that does not exist, the distribution retrieval fails.
2	Distribution file name	string	Specify the distribution directory as required. If you specify a file name for a distribution that does not exist, the distribution retrieval fails.

No.

Parameters

Data type

Description

Distribution directory name

string

Specify the distribution directory as required.

If you specify a directory name for a distribution that does not exist, the distribution retrieval fails.

Distribution file name

string

Specify the distribution directory as required.

If you specify a file name for a distribution that does not exist, the distribution retrieval fails.

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
200	OK	API processing succeeded.
403	Forbidden	Not authenticated,Authentication information is incorrect.
404	Not Found	The specified distribution does not exist, and in a Windows environment, the distribution cannot be accessed. However, in the case of a Windows environment, if you do not have access authority to the distributed file itself, no error will occur, and communication will be closed after a few minutes of non-response.

Status code

Message

Description

200

API processing succeeded.

403

Forbidden

Not authenticated,Authentication information is incorrect.

404

Not Found

The specified distribution does not exist, and in a Windows environment, the distribution cannot be accessed.

However, in the case of a Windows environment, if you do not have access authority to the distributed file itself, no error will occur, and communication will be closed after a few minutes of non-response.

If the status code is 200, the contents of the distribution file are returned to the message body of the response.

Notes

JP1/IM - The following are the requirements for distributions (files) to be stored in Manager (Linux).

■Distribution files

Can be handled as a file
he file must be compressed (gz format if the distribution destination is Linux environment, zip format if the distribution destination is Windows environment)
The file name should follow the "zueng031.tifNaming convention for distribution file name and storage destination directory name" below.

Grant the following permissions to the file:

Permissions	Owner	Group
`-r--r--r--`	`root`	`root`

The maximum file size is 300MB.

■Directory to create to store distributions

Create a directory to store the same distribution in the following storage location, and store the distribution in the created directory.

Storage location
`/opt/jp1imm/public/download`

The directory name should follow the "■Naming convention for distribution file name and storage destination directory name" shown below.

Grant the following permissions to the directory:

Permissions	Owner	Group
`drwxr-xr-x`	`root`	`root`

■Naming convention for distribution file name and storage destination directory name

[Reserved words]

File and directory names that begin with the following strings are reserved words: It is not case sensitive.

hitachi_
jp1_

The above reserved words are used when distributing files within the scope of functions and services provided by Hitachi products or JP1 products (including JP1/IM - Agent). It cannot be used to distribute other user-specific files.

[Allowed characters]

The following characters are allowed in file and directory names:

Alphanumeric characters
- (hyphen)
. (period)
_ (underscore)

■Distribution's file path, including extension

Must be 235 characters or less

If an environment variable is used for the file path, the file path (including extension) of the distribution after the environment variable is expanded must be 235 characters or less.

■Providers of Distributed Products

The provider of the distribution (distributed product) shall provide a way to check the version information of the distribution.

You can check the version information of the JP1/IM - Agent in the version file (Version.txt).

For details on where to store version file of JP1/IM - Agent, see (3) Integrated agent host (Windows) and (4) Integrated agent host (Linux) in Appendix A.4 JP1/IM - Agent in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

Examples

Example of request:

GET http://hostname:20703/download/im2-agent/xxx.zip

To Page Top