Produce a set of provisioning recommendations based on the provided input parameters.

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 details of volumes identified with {systemId}

Request

Get details of volumes identified with {systemId}

Security

bearer

Path

systemIdstringrequired

systemId of the storage system

Example: 7CE751P312

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/v1alpha1/storage-systems/7CE751P312/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/v1alpha1/storage-systems/storage-pools/{uid}","type":"storage-pools"},{"resourceUri":"/block-storage/v1alpha1/storage-systems/volume-sets/{uid}","type":"volume-sets"},{"resourceUri":"/block-storage/v1alpha1/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[].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/v1alpha1/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": [
    { … }
  ]
}

Produce a set of provisioning recommendations based on the provided input parameters.

Request

Produce a set of provisioning recommendations based on the provided input parameters.

Security

bearer

Bodyapplication/jsonrequired

sizeMibintegerrequired

volume size requirement

Example: 16384

hostGroupIdstring or null

host group id

Example: "a7c4e6593f51d0b98f0e40d7e6df04fd"

productFamilystring or null

Storage device type

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/storage-systems/provisioning-recommendations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sizeMib": 16384
  }'

Responses

Accepted

Headers

Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(RecommendationList)required

items[].idstringrequired

uid of the array

Example: "RTYTY123"

items[].capacityInfoobject or null(capacityInfoSolo)

items[].mgmtIpstring

management Ip of the array

Example: "1.2.3.4"

items[].namestring

name of the array

Example: "system_Name"

items[].productFamilystring

Storage device type. Possible values: deviceType1 and deviceType2

Example: "deviceType1"

items[].statestring or null

For deviceType1 State derived from ports, enclosure, disk and node state for deviceType2 state is state reported by deviceType2 array

Enum"NORMAL""DEGRADED"null

items[].systemWwnstring

WWN of the array

Example: "2FF70002AC018D94"

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

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/v1alpha1/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/v1alpha1/storage-systems/storage-pools/{uid}","type":"storage-pools"},{"resourceUri":"/block-storage/v1alpha1/storage-systems/volume-sets/{uid}","type":"volume-sets"},{"resourceUri":"/block-storage/v1alpha1/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[].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/v1alpha1/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": [
    { … }
  ]
}

snapshots

Operations

HPE Greenlake For Block Storage REST APIs. (1.0.0)

host-initiator-groups

host-initiators

host-paths

host-sets

hosts

storage-pools

storage-systems

volume-sets

volumes

Get details of volumes identified with {systemId}

Request

Responses

Was this helpful?

Produce a set of provisioning recommendations based on the provided input parameters.

Request

Responses

Was this helpful?

Get all volumes

Request

Responses

Was this helpful?

snapshots