Getting external volume information

Note:

External parity group: A parity group created by mapping volumes of an externally connected storage system. External parity groups are used to manage external volumes.
External volume: A volume created from an external parity group
External path group: A group consisting of multiple external volumes that use the same external path, which is a route that connects an external connection port to the port of an external storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-volumes

Request message

Object ID: None.

Query parameters

With each request, you can obtain information about a maximum of 200 external volumes. To obtain information about additional external volumes, execute the API request multiple times by using a combination of the count and startVolumeId parameters. By specifying the count parameter, you can also filter the external volume information you require.

Parameter	Type	Filter Condition
nickname	string	(Optional) Nickname of an external volume External volume information will also be obtained if part of the specified value matches the nickname of an external volume.
minTotalCapacity	long	(Optional) Minimum capacity of the external volumes (MiB) Specify the minimum capacity of the external volumes for which you want to obtain information as an integer in the range from `47` through `268435456`.
maxTotalCapacity	long	(Optional) Maximum capacity of the external volumes (MiB) Specify the maximum capacity of the external volumes for which you want to obtain information as an integer in the range from `47` through `268435456`.
status	string	(Optional) Specify one of the following values to obtain information about volumes in a particular state. `Normal`: Volumes in a normal state `Blockade`: Volumes that are blocked
volumeType	string	(Optional) Specify `Quorum Disk` (the quorum disk used on the global-active device) as the volume type of the external volume about which information is obtained.
externalParityGroupId	string	(Optional) ID of the external parity group Specify the ID in the format `X-Y`. For `X`, you can specify an integer in the range from `1` through `16384`. For `Y`, you can specify an integer in the range from `1` through `4096`.
externalPathGroupId	int	(Optional) Specify the ID of the external path group by using an integer in the range from `0` through `63231`.
startVolumeId	int	(Optional) Specify the ID of the external volume for which you want to start acquiring information, by using a value in the range from `0` through `65279`.
count	int	(Optional) Specify the number of external volumes for which information is obtained, by using a value in the range from `1` through `200`. If this parameter is omitted, `200` is assumed.

Body: None.

Response message

Body

The following is an example of the output when information is obtained about an external volume whose external volume type is quorum disk (if Quorum Disk is specified for the query parameter volumeType):

{
  "data": [
    {
      "id": 1655,
      "nickname": "externalVolumeFc",
      "totalCapacity": 16384,
      "Status": "Normal",
      "externalParityGroupId": "42-3",
      "externalPathGroupId": 91,
      "externalPathOfVolume": [
        {
          "portId": "CL5-A",
          "portProtocol": "FC",
          "externalPortWwn": "50060e8012000c60",
          "lun": 1463
        }
      ],
      "volumeTypes": [
          "Quorum Disk"
      ],
      "externalStorage": {
        "model": "VSP Gx00",
        "serial": "400012",
        "vendor": "HITACHI"
      },
      "quorumSetting": {
        "quorumId": 31,
        "pairedStorageModel": "M8",
        "pairedStorageSerial": "401026"
      }
  },
  {
    "id": 1656,
    "nickname": "externalVolumeIscsi",
    "totalCapacity": 16384,
    "status": "Normal",
    "externalParityGroupId": "9-1025",
    "externalPathGroupId": 1025,
    "externalPathOfVolume": [
      {
        "portId": "CL1-B",
        "portProtocol": "iSCSI",
        "externalPortIpAddress": "10.1.2.122",
        "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d00b",
        "externalTcpPortNumber": 3260,
        "lun": 1025,
        "virtualPortNumber": 1
       }
      ],
      "volumeTypes": [
        "Quorum Disk"
      ],
      "externalStorage": {
        "model": "VSP Gx00",
        "serial": "400012",
        "vendor": "HITACHI"
      },
      "quorumSetting": {
        "quorumId": 12,
        "pairedStorageModel": "M8",
        "pairedStorageSerial": "401206"
      }
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute	Type	Description
id	int	External volume ID
nickname	string	Nickname of the external volume This information appears if a nickname is defined.
totalCapacity	long	Total capacity of the external volume (MiB)
status	string	Status of the external volume `Normal`: Indicates that the volume is in a normal state `Busy`: Indicates that the volume's status is in transition `Blockade`: Indicates that the volume is blocked
externalParityGroupId	string	ID of the external parity group
externalPathGroupId	int	ID of the external path group
externalPathOfVolume	object[]	Information about each external path of the external volume appears. `portId` (string) ID of the external connection port `portProtocol` (string) Protocol of the port `FC` `iSCSI` `externalPortWwn` (string) WWN of the port of the externally connected storage system If an iSCSI port is specified, this attribute will not appear. `externalPortIpAddress` (string) IP address of the port of the externally connected storage system This attribute is output in IPv4 or IPv6 format. If an FC port is specified, this attribute will not appear. `externalPortIscsiName` (string) Name of the iSCSI target for the port of the externally connected storage system If an FC port is specified, this attribute will not appear. `externalTcpPortNumber` (int) TCP port number of the port of the externally connected storage system If an FC port is specified, this attribute will not appear. `virtualPortNumber` (int) Virtual port number of the external connection port This attribute will not appear in the following cases: If an FC port is specified If an iSCSI port is specified and the use of virtual ports is disabled `lun` (int) LUN assigned to the port of the externally connected storage system
volumeTypes	object[]	Volume type of an external volume `Quorum Disk`: The volume that is the quorum disk used by global-active device
externalStorage	object	Information about the externally connected storage system appears. `model` (string) Model of the externally connected storage system For details about the notation that is used when information about the externally connected storage system is output, see the Hitachi Universal Volume Manager User Guide. If a valid value cannot be obtained, this attribute does not appear. `serial` (string) Serial number of the externally connected storage system If a valid value cannot be obtained, this attribute does not appear. `vendor` (string) Vendor Identifier of the externally connected storage system If a valid value cannot be obtained, this attribute does not appear.
quorumSetting	object	If information about a quorum disk is set, the information will appear. `quorumId` (int) Quorum disk ID `pairedStorageModel` (string) Model of the paired storage systems that share the quorum disk `R8`: VSP G1000, VSP G1500 or VSP F1500 `R9`: VSP 5000 series `M8`: VSP E series, VSP G/F350, G/F370, G/F700, G/F900, VSP G200, G/F400, G/F600, G/F800 If information about the model cannot be obtained, `Unknown` will appear. `pairedStorageSerial` (string) Serial number of the paired storage system that shares the quorum disk

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes?volumeType="Quorum Disk"