Skip to main content
Hitachi NAS File Storage REST API Reference
- Last updated
-
-
Save as PDF
- Hardware and software requirements
- No image available
- This section describes the hardware and software required to support the REST API server.
- API common specifications
- No image available
- The chapter describes various API topics such as deprecation and purging policy and an inventory of supported APIs.
- Device resource
- No image available
- The device resource enables you to obtain important information about the storage system. Key information includes the cluster unique identifier, number of nodes, and the firmware version. In addition, the resource enables you to retrieve a list of licenses applied on the storage system.
- File storage statistics resource
- No image available
- The file storage statistics resource represents various file storage statistical objects. The genericStatistics object is a nested data structure to represent a generic statistics object. Note that most statistics reports activity for a preset time interval. This is the interval of time between the reset time and the current timestamp. Each statistical type may have its own reset time point. The storageStatistics object is a simple data structure that describes statistics data about a file storage.
- File system resource
- No image available
- The file system resource enables you to obtain detailed information about the
HNAS file system on the storage system. A file system is a namespace in which NFS/CIFS exports may be created and accessed. In addition, it allows you to perform key management operations related to file systems, such as creation, deletion, mount, and unmount operations.
- File system directory resource
- No image available
- The file system directory resource provides directory management for a file system. A tree clone is a recursive clone of a directory with all its sub-directories and files. The clone is produced instantly like a snapshot, even though the finishing of cloning may take some time.
- File system share resource
- No image available
- The file system share resource provides NFS (network file system) and CIFS (common Internet file system) application layer protocols that enable you to mount a remote file system across a network.
- File system snapshot resource
- No image available
- The file system snapshot resource provides management of a snapshot of a file system.
- iSCSI resource
- No image available
- The iSCSI resource enables you to create and manage iSCSI targets and logical units. iSCSI is an IP storage networking standard that links storage systems. By forwarding iSCSI commands over the network, iSCSI enables data transfer both over local area and wide area networks.
- iSCSI logical unit resource
- No image available
- The iSCSI logical unit (LUN) resource enables you to create and manage iSCSI logical units. iSCSI is an IP storage networking standard that links storage systems. By forwarding iSCSI commands over the network, iSCSI enables data transfer both over local area and wide area networks.
- Node resource
- No image available
- Node resources are the physical servers that make up the
Hitachi NAS Platform. Nodes can be standalone or part of a cluster. The node resource enables you to obtain detailed information about a cluster node. In addition, it allows you to retrieve information about the events that have occurred on the node.
- Object replication resource
- No image available
- Object replication replicates a snapshot of a file system to another server, typically remote, to provide backup and recovery of the source data.
- Object replication policy resource
- No image available
- Object replication policy resources are policies for object replication.
- Object replication schedule resource
- No image available
- Object replication schedule resources are schedules of object replication.
- Snapshot rules resource
- No image available
- Rules for creating new snapshots. Snapshots can be automatically created using snapshot rules associated with snapshot schedules.
- Storage pool resource
- No image available
- The storage pool resource refers to the virtual containers that provide storage for file systems. File systems consume storage pool space when they are created or as they expand.
- System drive resource
- No image available
- The system drive resource represents a logical drive on the file storage system on block storage physical logical units. The system drive resource enables you to retrieve detailed information about system drives on the storage system.
- Virtual server resource
- No image available
- The virtual server resource, also called EVS, consists of virtualized file services or administrative services. Each virtual server is assigned unique network settings and storage resources, providing the flexibility to logically partition access to shared storage resources. To ensure maximum data availability, you can configure virtual servers to automatically migrate between nodes in a cluster when failures occur. You can retrieve virtual servers in the system.
- Virtual volume resource
- No image available
- The virtual volume resource is a special directory that enables quota management. It generates various email notifications to subscribed receivers indicating an exceeded quota.
- Virtual volume quota resource
- No image available
- The virtual volume quota resource provides quota management for a virtual volume to which a specific quota is associated.
- Troubleshooting
- No image available
- This chapter provides steps for troubleshooting.
