Getting volume information

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

None.

Query parameters

With each request, you can obtain information about a maximum of 500 volumes. To obtain information about additional 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 volume information you require.

Parameter	Type	Filter Condition
poolId	int	(Optional) ID of the pool to which the volumes belong If poolName is specified, do not specify this parameter.
poolName	string	(Optional) Name of the pool to which the volumes belong Volume information will also be obtained if part of the specified value matches the pool name. If poolId is specified, do not specify this parameter. If both poolId and this parameter are specified, this parameter is ignored.
serverId	int	(Optional) ID of the server to which the volumes have been attached If serverNickname is specified, do not specify this parameter.
serverNickname	string	(Optional) Nickname of the server to which the volumes have been attached Volume information will also be obtained if part of the specified value matches the nickname of a server. If serverId is specified, do not specify this parameter. If both serverId and this parameter are specified, this parameter is ignored.
nickname	string	(Optional) Nickname of the volumes Volume information will also be obtained if part of the specified value matches the nickname of the volume.
minTotalCapacity	long	(Optional) Minimum capacity of the volumes (MiB) Specify the minimum capacity of the 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 volumes (MiB) Specify the maximum capacity of the volumes for which you want to obtain information as an integer in the range from 47 through 268435456.
minUsedCapacity	long	(Optional) Minimum usage capacity of the volumes (MiB) Specify the minimum usage capacity of the volumes for which you want to obtain information as an integer in the range from 0 through 268435456.
maxUsedCapacity	long	(Optional) Maximum usage capacity of the volumes (MiB) Specify the maximum usage capacity of the volumes for which you want to obtain information an integer in the range from 0 through 268435456.
startVolumeId	int	(Optional) Specify the ID of the 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 volumes from which to obtain information, by using a value in the range from 1 through 500. If this parameter is omitted, 500 is assumed.

Body

None.

Response message

Body

The following is an example of output of obtained information for a volume that belongs to the pool with ID 63 (63 is specified in the poolId query parameter):

{
  "data": [
    {
      "id": 3,
      "nickname": "JH-26216_DP",
      "poolId": 63,
      "poolName": "pool-1",
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "savingSetting": "COMPRESSION",
      "compressionAcceleration": true,
      "capacitySavingStatus": "Enabled",
      "numberOfConnectingServers": 0,
      "numberOfSnapshots": 0,
      "volumeTypes": []
    },
    {
      "id": 4,
      "nickname": "JH-26216_DP",
      "poolId": 63,
      "poolName": "pool-1",
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "savingSetting": "DISABLE",
      "capacitySavingStatus": "Disabled",
      "numberOfConnectingServers": 0,
      "numberOfSnapshots": 0,
      "volumeTypes": []
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute	Type	Description
id	int	Volume ID
nickname	string	Nickname
poolId	int	ID of the pool to which the volume belongs
poolName	string	Name of the pool to which the volume belongs This attribute do not appear when the volume is being created or deleted.
totalCapacity	long	Total capacity of the volume (MiB)
usedCapacity	long	Used capacity of the volume (MiB) 0 appears when the volume is being created or deleted.
savingSetting	string	Whether capacity saving (deduplication and compression) is enabled: DEDUPLICATION_AND_COMPRESSION: Deduplication and compression is enabled. COMPRESSION: Compression is enabled. DISABLE: No settings are specified.
compressionAcceleration	boolean	Whether using compression acceleration with the capacity saving function is enabled true: Enabled false: Disabled This attribute appears if the storage system is a VSP E series storage system and capacity saving is enabled for the volume.
capacitySavingStatus	string	Capacity saving (deduplication and compression) settings: Disabled: Capacity saving is disabled. Enabled: Capacity saving is enabled. Rehydrating: Capacity saving is being disabled. Enabling: Capacity saving is being enabled. Deleting: Volumes for which the capacity saving is enabled are being deleted. Converting: Compression method for capacity saving is being changed. Failed: Data on the deduplication system data volumes is invalid.
numberOfConnectingServers	int	Number of servers managed by Storage Advisor Embedded that are connected to the volume
numberOfSnapshots	int	Number of snapshots
volumeTypes	object[]	Volume Types Snapshot: Volumes that are created from snapshots and for which volume IDs are defined. System: Volumes used for deduplication system data volumes or journal volumes. Command Device: Volumes used as command devices. SLU: Volumes with the SLU (Subsidiary Logical Unit) attribute. Attached Unmanaged: Volumes are attached using other management tools.

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/volumes?poolId=63