Skip to content
API reference
/
/
Get volume-set identified...

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

Get all volume-sets for a systemId

Request

Get all volume sets for a 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 volset and systemId eq 7CE751P312
sortstring

oData query to sort by Key.

Example: sort=systemId 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/storage-systems/7CE751P312/volume-sets \
  -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(fleetVolumesetWithoutRansomware)required
items[].​idstringrequired

id of the volume set Filter

Example: "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0"
items[].​typestringrequired

type

Example: "string"
items[].​appTypestring or null

Application name Filter

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

Associated Links Details

items[].​commonResourceAttributesobject or null(commonResourceAttributesfleet)
items[].​customerIdstring or null

customerId

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

generation Filter, Sort

Example: 0
items[].​healthStatestring or null

health state

items[].​hostWrittenCapacityMiBnumber or null(float64)

Host written capacity in MiB

items[].​intrinsicResourcestring or null

Intrinsic resource type

items[].​iopsnumber or null(float64)

IOPS

items[].​isInternalboolean or null

Is an internal resource

items[].​latencynumber or null(float64)

Latency

items[].​locationstring or null

location

items[].​namestring or null

name of volume-set Filter, Sort

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

Product Family

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

Provisioned size in MiB

items[].​resourceUristring or null

resourceUri for detailed volume object

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

Size in MiB

items[].​spaceWarningnumber or null(float64)

Space warning set for the resource

items[].​subTypestring or null

subType

items[].​systemIdstring or null

system ID. Filter, Sort

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

ThinSavings

items[].​throughPutnumber or null(float64)

ThroughPut for the resource

items[].​totalReservedMiBnumber or null(float64)

Total reserved MiB for the resource

items[].​usedCapacityPercentnumber or null(float64)

Used capacity percentage

items[].​usedSizeMiBnumber or null(float64)

Used size in MiB

items[].​volumeSetIdstring or null

UID of the volume set Id

items[].​volumeTypestring or null

Type of volume

items[].​volumesCountinteger or null

The number of volumes in an application

Example: 5
items[].​wwnstring or null

wwn of the volume

totalinteger

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

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

Get volume-set identified by id

Request

Get volume-set identified by id

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of Volume Set

Example: fd3244ef7f1ab8bd16500c7a41bdf8f8
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/storage-systems/7CE751P312/volume-sets/fd3244ef7f1ab8bd16500c7a41bdf8f8 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

id of the volume set

Example: "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0"
typestringrequired

type

Example: "string"
appTypestring or null

Application name Filter

Example: "Oracle Database"
associatedLinksArray of objects or null

Associated Links Details

commonResourceAttributesobject or null(commonResourceAttributesfleet)
customerIdstring or null

customerId

Example: "string"
generationinteger or null

generation Filter, Sort

Example: 0
namestring or null

name of volume-set

Example: "snap11"
productFamilystring or null

Product Family

Example: "deviceType1"
resourceUristring or null

resourceUri for detailed volume object

Example: "/block-storage/v1/storage-systems/volume-sets"
systemIdstring or null

system ID.

Example: "7CE751P312"
volumesCountinteger or null

The number of volumes in an application

Example: 5
Response
application/json
{
  "appType": "Oracle Database",
  "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,
  "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  "name": "snap11",
  "productFamily": "deviceType1",
  "resourceUri": "/block-storage/v1/storage-systems/volume-sets",
  "systemId": "7CE751P312",
  "type": "string",
  "volumesCount": 5
}

Get all volume-sets

Request

Get all volume sets

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 volset and systemId eq 7CE751P312
sortstring

oData query to sort by Key.

Example: sort=systemId 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/volume-sets \
  -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(fleetVolumesetWithoutRansomware)required
items[].​idstringrequired

id of the volume set Filter

Example: "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0"
items[].​typestringrequired

type

Example: "string"
items[].​appTypestring or null

Application name Filter

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

Associated Links Details

items[].​commonResourceAttributesobject or null(commonResourceAttributesfleet)
items[].​customerIdstring or null

customerId

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

generation Filter, Sort

Example: 0
items[].​healthStatestring or null

health state

items[].​hostWrittenCapacityMiBnumber or null(float64)

Host written capacity in MiB

items[].​intrinsicResourcestring or null

Intrinsic resource type

items[].​iopsnumber or null(float64)

IOPS

items[].​isInternalboolean or null

Is an internal resource

items[].​latencynumber or null(float64)

Latency

items[].​locationstring or null

location

items[].​namestring or null

name of volume-set Filter, Sort

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

Product Family

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

Provisioned size in MiB

items[].​resourceUristring or null

resourceUri for detailed volume object

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

Size in MiB

items[].​spaceWarningnumber or null(float64)

Space warning set for the resource

items[].​subTypestring or null

subType

items[].​systemIdstring or null

system ID. Filter, Sort

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

ThinSavings

items[].​throughPutnumber or null(float64)

ThroughPut for the resource

items[].​totalReservedMiBnumber or null(float64)

Total reserved MiB for the resource

items[].​usedCapacityPercentnumber or null(float64)

Used capacity percentage

items[].​usedSizeMiBnumber or null(float64)

Used size in MiB

items[].​volumeSetIdstring or null

UID of the volume set Id

items[].​volumeTypestring or null

Type of volume

items[].​volumesCountinteger or null

The number of volumes in an application

Example: 5
items[].​wwnstring or null

wwn of the volume

totalinteger

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

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

volumes

The volumes API allows the management of volumes

Operations

snapshots

Operations