System configuration of the REST API

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
This section explains the basic system configuration for using the REST API.

The following shows the basic system configuration of the REST API.

Storage system
By using the REST API, you can get information from the storage system or change the configuration of the storage system. The REST API can perform operations on the following storage systems:
  • VSP 5000 series
  • VSP E series
  • VSP F350, F370, F700, F900
  • VSP G350, G370, G700, G900
SVP (Service Processor)

This is a computer that has basic functions for managing storage systems. You can manage a storage system via an external device that communicates with the SVP in the case of a VSP 5000 series storage system.

GUM (Gateway for Unified Management)

This is a computer that has basic functions for managing storage systems. You can manage a storage system via an external device that communications with the GUM in the case of a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system.

GUM exists in each controller, CTL1 and CTL2.

REST API server

This is a component that acts as a server to receive REST API requests from REST API clients, issue orders to the storage system, and then return the execution results to the REST API clients.

The REST API server is installed on the storage system's SVP in the case of a VSP 5000 series storage system, and on the storage system's GUM in the case of a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system.

Note:

In the case of VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage systems, the REST API servers that are allocated on the GUM of CTL1 and CTL2 operate independently. Therefore, when a failure occurs in one GUM, the REST API server on the other GUM can be used to run the operation. However, the following information is not inherited by the REST API servers:

  • Job information
  • Remote storage system information

If necessary, register information about the remote storage systems to the other REST API server.

REST API clients
The REST API clients issue requests to the REST API server. The term "REST API client" refers to software or scripts that use the REST API.

In the case of VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage systems, you can use the REST API to run API requests other than those described in this manual, such as API requests that get information in a simple format and API requests that return responses at a high speed. For details about these API requests, see the Hitachi Storage Advisor Embedded Guide on the Hitachi Vantara Knowledge website.

Note: The REST API server links internally with the CCI of the SVP or the GUM. The maximum number of CCI instances used by the REST API server is 1000, in the range from 1048 to 2047. If you use the CCI of the SVP or the GUM for a purpose other than the REST API, use an instance number that is not in the range from 1048 to 2047.