Getting a list of remote storage systems

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

The following request gets a list of information about the storage systems registered on the REST API server.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-storages

Request message

Object ID: None.

Query parameters: None.

Body: None.

Response message

Body

{
  "data": [
    {
      "storageDeviceId": "886000123456",
      "dkcType": "Local",
      "restServerIp": "192.0.2.100",
      "restServerPort": 443,
      "model": "VSP G900",
      "serialNumber": 123456,
      "ctl1Ip": "192.0.10.10",
      "ctl2Ip": "192.0.10.11",
      "communicationModes": [
        {
          "communicationMode": "lanConnectionMode"
        }
      ]
    },
    {
      "storageDeviceId": "886000123457",
      "dkcType": "Remote",
      "restServerIp": "192.0.2.101",
      "restServerPort": 443,
      "model": "VSP G900",
      "serialNumber": 123457,
      "ctl1Ip": "192.0.10.20",
      "ctl2Ip": "192.0.10.21",
      "communicationModes": [
        {
          "communicationMode": "lanConnectionMode"
        }
      ]
    }
  ]
}

Attribute	Type	Description
storageDeviceId	string	Storage device ID
dkcType	string	Type of storage system `Local`: Local storage system (The storage system where the REST API server that received the request exists.) `Remote`: Remote storage system (The storage system registered on the REST API server of the local storage system.)
restServerIp	string	IP address used by the REST API server of the remote storage system
restServerPort	int	Port number used for SSL communication by the REST API server of the remote storage system
model	string	Model name of the storage system
serialNumber	int	Serial number of the storage system
ctl1Ip	string	IP address of controller board 1 This attribute is output for VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.
ctl2Ip	string	IP address of controller board 2 This attribute is output for VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.
communicationModes	object[]	The following attributes related to the communication mode between the REST API server and the storage system are output: If multiple communication modes are output, the mode that is output at the top will be prioritized in communication. communicationMode (string) Communication mode `proxyMode` `lanConnectionMode` proxies (object[]) The following attributes about the relay server are output: proxyIp (string) IP address proxyPort (int) Port number

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-storages