Getting a list of virtual storage machines

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 obtains a list of virtual storage machines. You can get information such as serial numbers, model names, and resource group IDs.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

None.

Query parameters

None.

Body

None.

Response message

Body
{
  "data" : [
    {
      "virtualStorageDeviceId" : "800000002015",
      "virtualSerialNumber" : "2015",
      "virtualModel" : "VSP G1000/G1500 and VSP F1500",
      "resourceGroupIds" : [ 
        1,
        3
      ],
      "virtualStorageTypeId" : "R8"
    },
    {
      "virtualStorageDeviceId" : "882000400002",
      "virtualSerialNumber" : "400002",
      "virtualModel" : "VSP G350",
      "resourceGroupIds" : [ 
        0, 
        2, 
        4
      ],
      "virtualStorageTypeId" : "M850S1"
    }
  ]
}

Attribute

Type

Description

virtualStorageDeviceId

string

Storage device ID of the virtual storage machine

virtualSerialNumber

string

Serial number of the virtual storage machine

virtualModel#

string

Model name of the virtual storage machine

virtualModelDetail#

string

Detailed model name of the virtual storage machine

This parameter is output if the virtual storage machine is in the VSP 5000 series.

resourceGroupIds

int[]

Resource group ID

virtualStorageTypeId

string

Storage system type ID of the virtual storage machine

If storage system is not be determined, Unknown is output.

#: For virtual storage machines in the VSP 5000 series, the series name VSP 5000 series AFA or VSP 5000 series hybrid is output for the virtualModel attribute, and VSP 5100, 5500, VSP 5200, 5600, VSP 5100H, 5500H, or VSP 5200H, 5600H is output for the virtualModelDetail attribute.

Status codes

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

Coding example

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