For VSP One B20 storage systems, the REST API is included in the storage system. This REST API is called "Platform REST API" in this manual.
- REST API clients
- Rest API clients are software programs or scripts that use the REST API to issue requests to the REST API server.
- Management server
- The server on which the Configuration Manager REST API is installed.
- Configuration Manager REST API server
-
This component receives a REST API request from a REST API client, issues the request to the storage system, and then returns the result to the REST API client.
The Configuration Manager REST API server sends the request received from the REST API client to the Platform REST API server, and then returns the results received from the Platform REST API server to the REST API client.
Note:In the case of a VSP One B20 storage system, one of the Platform REST API servers on the ESM of CTL01 or of CTL02 is operating. If a failure occurs on the ESM that is operating, the communication destination is switched to the Platform REST API server on the other ESM and information is inherited between the Platform REST API servers, thereby allowing you to continue to perform operations. However, when information is inherited between the Platform REST API servers, the request body of the job information might be truncated or some of the error objects (message, cause, solution) in the job information might be missing.
In addition, if the following conditions are met, the information of the registered remote storage system is also inherited:
- A mutual registration operation was performed for the remote storage system.
- After the communication destination is switched, communication to the remote storage system is normal.
- ESM (Embedded Storage Manager)
-
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 ESM in the case of a VSP One B20 storage system.
Although ESM exists on both controllers CTL01 and CTL02, it communicates with REST API clients by using an IP address (service IP) that represents these controllers.
- Platform REST API server
-
This is a REST API server included in the ESM of VSP One B20 storage systems. This component receives a REST API request from a REST API client, issues an order to the storage system, and then returns the execution result to the REST API client.
- Storage system
-
By using the REST API, you can get information from the storage system or change the storage system configuration.