6.5 HP StoreAll OS User Guide

12 HTTP-REST API file-compatible mode shares
The StoreAll REST API share in file-compatible mode provides programmatic access to user-stored
files and their metadata. The metadata is stored on the HP StoreAll Express Query database in the
StoreAll cluster and provides fast query access to metadata without scanning the file system. For
more information on managing Express Query, see “Express Query” (page 294).
The StoreAll REST API file-compatible mode provides the ability to upload and download files,
assign custom (user-defined) metadata to files and directories, manage file retention settings, and
query the system and custom metadata of files and directories. You can associate any number of
custom (user-defined) metadata attributes to any file or directory where the Express Query metadata
store is enabled. Each custom attribute consists of an attribute name and assigned value. The API
provides commands to create custom metadata entries for a file, replace values of existing entries,
and delete entries. You can create HTTP-StoreAll REST API shares to access Express Query on the
file system.
When the StoreAll server receives an HTTP request, it parses the URL Path from the URL (immediately
following the hostname and port in the URL) and directs the request to the appropriate handler for
that HTTP share, which can be either a standard HTTP share, a file compatible mode API share,
or an object mode API share.
When listing StoreAll REST API-enabled shares through the Management Console, the RestApiMode
field indicates the share type and the URL Path field indicates the handler for a given HTTP request.
You can also obtain information about the RestAPIMode and URL Path, by entering the following
CLI command:
ibrix_httpshare -l
The following is displayed.
Component overview
The StoreAll REST API for the file-compatible mode has a number of components, such as custom
metadata assignments, metadata queries, and retention properties assignments.
File content transfer
You can upload, download, and delete files. You can also force upload or delete operations
durable on disk before the HTTP response is sent to the user by adding a request header to perform
this operation. You can still make a request that syncs the entire file system, forcing all buffers to
be written to the disk. You can view the list of files and subdirectories of any directory in the HTTP
share, provided you have permission to navigate to that directory.
Custom metadata assignment
You can associate any number of custom (user-defined) metadata attributes to any file or directory
stored on a StoreAll retention-enabled file system where the Express Query metadata store is
enabled. Each custom attribute consists of an attribute name and assigned value. The API provides
commands to create custom metadata entries for a file, replace values of existing entries, and
delete entries.
Component overview 217