Skip to content
API reference
/
/
Get details of Volume ide...

HPE Greenlake For Block Storage REST APIs (1.0.0)

HPE Greenlake For Block Storage REST APIs

Download OpenAPI description
block-storage-api.json
block-storage-api.yaml
Overview
License
HPE End User License Agreement
Languages
Servers
https://eu1.data.cloud.hpe.com/
https://us1.data.cloud.hpe.com/
https://jp1.data.cloud.hpe.com/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/block-storage/public/openapi/block-storage-latest/v1/block-storage-api/

host-initiator-groups

The Host service API allows the management of Host Group

Operations

host-initiators

The Host service API allows the management of Host, initiators

Operations

host-paths

The ports API allows the management of host-paths

Operations

host-sets

The ports API allows the management of host-sets

Operations

hosts

The ports API allows the management of hosts

Operations

storage-pools

The pools API allows the management of storage pools

Operations

storage-systems

The storage-systems API allows the management of storage device.

Operations

volume-sets

The Volume-sets API allows the management of volume sets

Operations

volumes

The volumes API allows the management of volumes

Operations

Get all volumes

Request

Get all volumes

Security
bearer
Query
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
filterstring

oData query to filter by Key.

Example: filter=name eq array1 and wwn eq 2FF70002AC018D94
sortstring

oData query to sort by Key.

Example: sort=systemWWN desc
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/volumes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(fleetVolumeDetailsList)required
items[].​idstringrequired

UUID string uniquely identifying the storage system object. Filter

Example: "e66ed5ce8d35961481a48b4f78bb06b4"
items[].​typestringrequired

type

Example: "volume"
items[].​associatedLinksArray of objects or null

Associated Links

Example: [{"resourceUri":"/block-storage/v1/storage-systems/storage-pools/{uid}","type":"storage-pools"},{"resourceUri":"/block-storage/v1/storage-systems/volume-sets/{uid}","type":"volume-sets"},{"resourceUri":"/block-storage/v1/storage-systems/{uid}","type":"systems"}]
items[].​commonResourceAttributesobject or null(commonResourceAttributesfleet)
items[].​customerIdstring or null

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​generationinteger or null

generation

Example: 0
items[].​healthStatestring or null

Health State of volume. Filter, Sort

Example: "NORMAL"
items[].​hostWrittenCapacityMiBnumber or null(float64)

Host written data size in MiB. Filter, Sort

Example: 0
items[].​intrinsicResourcestring or null

type of volume

Example: "volume"
items[].​isInternalboolean or null

boolean value which specifies if it is a systemVolume or not

Example: false
items[].​isRansomwareDegradedboolean or null

A boolean value that specifies if the volume is in degraded state due to ransomware.

Example: false
items[].​namestring or null

A user friendly name to identify the storage system volume (resourceName). Filter, Sort

Example: "Finance"
items[].​productFamilystring or null

Product Family

Example: "deviceType1"
items[].​provisionedSizeMiBnumber or null(float64)

Provisioned Size in MiB

Example: 2048
items[].​resourceUristring or null

resourceUri for detailed volume object

Example: "/block-storage/v1/storage-systems/volumes"
items[].​sizeMiBnumber or null(float64)

Size in MiB Filter, Sort

Example: 2048
items[].​spaceWarningnumber or null(float64)(spaceWarning)
items[].​subTypestring or null

subType of the volume

Example: "PROVTYPE_DDS"
items[].​systemIdstring or null

SystemUid/Serial Number of the array. Filter, Sort

Example: "7CE751P312"
items[].​thinSavingsstring or null

Thin savings

Example: "1:1"
items[].​usedCapacityPercentnumber or null

Used capacity percentage of volume.

Example: 1.2345
items[].​usedSizeMiBnumber or null(float64)

Size in MiB

items[].​volumeSetIdstring or null

SystemUid/serialNumber of the volumeSet.

Example: "7CE751P312"
items[].​volumeTypestring or null

VV Type

Example: "VVTYPE_BASE"
items[].​wwnstring or null

Volume wwn.

Example: "60002AC0000000000000006B0001FFEB"
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get details of Volume identified by {id}

Request

Get details of Volume identified by {id}

Security
bearer
Path
idstringrequired

UID(volumeuid) of the storage system

Example: a7c4e6593f51d0b98f0e40d7e6df04fd
Query
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

UUID string uniquely identifying the storage system object.

typestringrequired

type

Example: "string"
associatedLinksArray of objects or null

Associated Links

Example: [{"resourceUri":"/block-storage/v1/storage-systems/storage-pools/{uid}","type":"storage-pools"},{"resourceUri":"/block-storage/v1/storage-systems/volume-sets/{uid}","type":"volume-sets"},{"resourceUri":"/block-storage/v1/storage-systems/{uid}","type":"systems"}]
commonResourceAttributesobject or null(commonResourceAttributesfleet)
customerIdstring or null

customerId

Example: "string"
generationinteger or null

generation

Example: 0
healthStatestring or null

Health State of volume.`

Example: "NORMAL"
hostWrittenCapacityMiBnumber or null(float64)

Host written data size in MiB.

intrinsicResourcestring or null

Type of volume

Example: "volume"
isInternalboolean or null

boolean value which specifies if it is a systemVolume or not Filter

Example: false
isRansomwareDegradedboolean or null

A boolean value that specifies if the volume is in degraded state due to ransomware.

Example: false
namestring or null

A user friendly name to identify the storage system volume (resourceName).

Example: "Finance"
productFamilystring or null

Product Family

Example: "deviceType1"
provisionedSizeMiBnumber or null(float64)

Provisioned Size in MiB

Example: 2048
resourceUristring or null

resourceUri for detailed volume object

Example: "/block-storage/v1/storage-systems/2FF70002AC01F0FF/volumes/{uid}"
sizeMiBnumber or null(float64)

Size in MiB

spaceWarningnumber or null(float64)(spaceWarning)
subTypestring or null

subType of the volume

Example: "PROVTYPE_DDS"
systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
thinSavingsstring or null

Thin savings

Example: "1:1"
usedCapacityPercentnumber or null

Used capacity percentage of volume. Filter, Sort

Example: 1.2345
usedSizeMiBnumber or null(float64)

Size in MiB

volumeSetIdstring or null

SystemUid/serialNumber of the volumeSet.

Example: "7CE751P312"
volumeTypestring or null

VV Type

Example: "VVTYPE_BASE"
wwnstring or null

Volume wwn.

Response
application/json
{
  "associatedLinks": [
    { … },
    { … },
    { … }
  ],
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "customerId": "string",
  "generation": 0,
  "healthState": "NORMAL",
  "hostWrittenCapacityMiB": 0,
  "id": "string",
  "intrinsicResource": "volume",
  "isInternal": false,
  "isRansomwareDegraded": false,
  "name": "Finance",
  "productFamily": "deviceType1",
  "provisionedSizeMiB": 2048,
  "resourceUri": "/block-storage/v1/storage-systems/2FF70002AC01F0FF/volumes/{uid}",
  "sizeMiB": 0,
  "spaceWarning": 0,
  "subType": "PROVTYPE_DDS",
  "systemId": "7CE751P312",
  "thinSavings": "1:1",
  "type": "string",
  "usedCapacityPercent": 1.2345,
  "usedSizeMiB": 0,
  "volumeSetId": "7CE751P312",
  "volumeType": "VVTYPE_BASE",
  "wwn": "string"
}

snapshots

Operations