Skip to content
/storage-systems

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

Get Application Summary for an HPE Alletra Storage MP B10000 storage system

Request

Get Application Summary for an HPE Alletra Storage MP B10000 storage system

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/application-summary \
  -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(DeviceType4applications)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​applicationSetTypestring

Name of the application

Example: "Microsoft Exchange"
items[].​totalSizeMiBnumber or null(float64)

The total volume size in MiB of the application

Example: 307200
items[].​totalUsedSizeMiBnumber or null(float64)

The total used size in Mib of the application

Example: 7200
items[].​volumesCountinteger or null

The number of volumes in an application

Example: 5
totalinteger

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

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

Get latest capacity trend data and forecasted data

Request

Get latest capacity trend data and forecasted data

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
start-timeinteger

Start time from which forecasted data is needed

Example: start-time=1591601529000
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/capacity-forecast \
  -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(DeviceType4CapacityForecast)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​confidenceLevelnumber or null(float64)

Confidence level represents the level of certainity or probability of a forecast made by a model

Example: 90
items[].​customerIdstring or null

CustomerId of the user

Example: "string"
items[].​forecastedArray of objects or null or null(DeviceType4capacitySeriesForecastData)
items[].​historicArray of objects or null or null(DeviceType4capacitySeriesHistoricData)
items[].​messagestring or null

A message to describe why forecast data is not available

Example: "No data available"
totalinteger

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

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

Get capacity time until full data for an HPE Alletra Storage MP B10000 storage system

Request

Get capacity time until full data for an HPE HPE Alletra Storage MP B10000 storage system

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/capacity-timeuntilfull \
  -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(DeviceType4CapacityTimeUntilFull)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​customerIdstring or null

input customer id

Example: null
items[].​deviceTypestring or null

device type of the system

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

input system id

Example: "4UW0004226"
items[].​timeUntilFullinteger or null(int64)

epoch timestamp in millisecond denoting the estimated tuf of the system

Example: 1605063600000
totalinteger

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

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

Get Top headroom contribution by volumes/Apps for device-type4

Request

Get Top headroom contribution by volumes/Apps for device-type4

Security
bearer
Path
systemIdstringrequired

SystemId of the HPE Alletra Storage MP B10000 storage system

Example: ABC239XFZ9
Query
time-interval-minintegerrequired

Time interval granularity in minutes

Enum5601440
rangestringrequired

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

Example: range=startTime eq 1605063600 and endTime eq 1605186000
resource-typestring

Query to select resource (volumes, volume-set) for getting Headroom Contributors

Default "VOLUMES"
Enum"VOLUMES""VOLUME-SET"
Example: resource-type=VOLUMES
curl -i -X GET \
  'https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/ABC239XFZ9/headroom-contribution?time-interval-min=5&range=startTime+eq+1605063600+and+endTime+eq+1605186000' \
  -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(headroomContribution)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​associatedLinksArray of objects or null or null(DeviceType4sysAssociatedLinks)
items[].​averageHeadroomUtilizationobject or null(aggregateData)
items[].​customerIdstring

id specific to the customer

items[].​endTimenumber

endTime refers to last/ending period of the interval for which contributors are fetched

Example: 1669880791
items[].​headroomContributionobject(headroomResponse)
items[].​remainingArray of objects or null(resourcesResponse)
items[].​resourceTypestring

Resource type - volumes

items[].​startTimenumber

startTime refers to starting period of the interval for which contributors are fetched

Example: 1669794391
items[].​systemArray of objects or null(resourcesResponse)
items[].​systemIdstring or null

Serial Number of the array

Example: "7CEFVC12"
totalinteger

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

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

Get hotspots for HPE Alletra Storage MP B10000 storage system based on resourceType `VOLUMES or VOLUME-SET` and metricType `LATENCY`

Request

Get the top hotspots segregated into read and write categories

Security
bearer
Path
systemIdstringrequired

SystemId of the HPE Alletra Storage MP B10000 storage system

Example: ABC239XFZ9
Query
time-interval-minintegerrequired

Time interval granularity in minutes

Enum5601440
rangestringrequired

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

Example: range=startTime eq 1605063600 and endTime eq 1605186000
operation-typestring

Indicates if hotspots metrics to be calculated for read, write or both operations. If this field is not provided, hotspots are calculated for both operations

Enum"READ""WRITE""ALL"
Example: operation-type=READ
resource-typestring

Query to select resource (volumes, volume-set) for analytics

Default "VOLUMES"
Enum"VOLUMES""VOLUME-SET"
Example: resource-type=VOLUMES
metric-typestring

Query to select metric for which hotspot is to calculated

Default "LATENCY"
Value"LATENCY"
Example: metric-type=LATENCY
curl -i -X GET \
  'https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/ABC239XFZ9/hotspots?time-interval-min=5&range=startTime+eq+1605063600+and+endTime+eq+1605186000' \
  -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(hotspots)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​associatedLinksArray of objects or null or null(DeviceType4sysAssociatedLinks)
items[].​customerIdstring

CustomerId

items[].​endTimenumber

End time of the interval for which hotspots are calculated

Example: 1669880791
items[].​hotspotsobject or null(hotspotsDataPerCategory)
items[].​metricTypestring

Metric which is used to calculate hotspots

Example: "latency"
items[].​resourceTypestring

Resource for which hotspots is calculated

Example: "volumes"
items[].​startTimenumber

Start time of the interval for which hotspots are calculated

Example: 1669794391
items[].​systemIdstring

Serial number of the array

Example: "ABC239XFZ9"
totalinteger

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

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

Get system level latency factors

Request

Get system level latency factors of system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
time-interval-minintegerrequired

Time interval granularity in minutes

Enum5601440
rangestring

range will define start and end time in which query has to be made.

Example: range=startTime eq 1605063600 and endTime eq 1605186000
curl -i -X GET \
  'https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/latency-factors?time-interval-min=5' \
  -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(DeviceType4SystemLatencyFactors)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​customerIdstring

Customer identifier

items[].​endTimeinteger(int64)

End time of the interval for which latency factors are determined

Example: 1669880791
items[].​latencyBandsobject or null
items[].​startTimeinteger(int64)

Start time of the interval for which latency factors are determined

Example: 1669794391
items[].​systemFactorsMetricsArray of objects or null or null(DeviceType4FactorData)
items[].​systemIdstring

System identifier

totalinteger

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

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

Get resource contention data for resources `DISK and CPU` for device-type4

Request

Get the top volume contributors and timeseries data for disk and cpu resource contention

Security
bearer
Path
systemIdstringrequired

SystemId of the HPE Alletra Storage MP B10000 storage system

Example: ABC239XFZ9
Query
time-interval-minintegerrequired

Time interval granularity in minutes

Enum5601440
rangestringrequired

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

Example: range=startTime eq 1605063600 and endTime eq 1605186000
resource-contention-typestring

Indicates if resource contention has to be calculated for disk, cpu or both resources. If this field is not provided, resource contention is calculated for both resources

Enum"DISK""CPU""ALL"
Example: resource-contention-type=DISK
curl -i -X GET \
  'https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/ABC239XFZ9/resource-contention?time-interval-min=5&range=startTime+eq+1605063600+and+endTime+eq+1605186000' \
  -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(resourceContention)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​associatedLinksArray of objects or null or null(DeviceType4sysAssociatedLinks)
items[].​cpuContentionobject or null(resourceContentionData)
items[].​customerIdstring

CustomerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​diskContentionobject or null(resourceContentionData)
items[].​endTimenumber

End time of the interval for which resource contention is computed

Example: 1669880791
items[].​iomRecommendedboolean

Indicates if resource-contention is IOM based Storage CPU Contention

Example: true
items[].​startTimenumber

Start time of the interval for which resource contention is computed

Example: 1669794391
items[].​systemIdstring

Serial number of the array

Example: "ABC239XFZ9"
totalinteger

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

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

Get all insights.

Request

List all insights.

Security
bearer
Query
filterstring

GET /block-storage/v1/devtype4-system-insights?filter=type eq 'TIME_UNTIL_FULL': GET /block-storage/v1/devtype4-system-insights?filter=score lt 3: GET /block-storage/v1/devtype4-system-insights?filter=value gt 60: GET /block-storage/v1/devtype4-system-insights?filter=date eq '2024-05-12':

curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-system-insights \
  -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(InsightsData)required
items[].​idstringrequired

Primary identifier for the insight.

items[].​typestringrequired

Type of the insight

Enum"TIME_UNTIL_FULL""RESOURCE_CONTENTION""LATENCY_ANOMALIES"
items[].​categorystring

Category of the insight

Enum"CAPACITY""PERFORMANCE"
items[].​causestring or null
items[].​createTimeinteger(int64)

Timestamp for the insight.

items[].​customerIdstring

Primary identifier for the customer (UUID) associated with the insight

items[].​datestring(date)

Date in string format corresponding to the timestamp field.

items[].​detailsobject(InsightDetails)
items[].​insightDetailsUristring

URI of the insight details page

items[].​insightUristring

URI of the insight

items[].​lastUpdatedTimeinteger(int64)
items[].​remediationstring or null
items[].​resourceDetailsobject(ResourceDetail)
items[].​scoreinteger(int64)

Score of the insight - 0,1,2...10

items[].​severitystring

Severity of the insight - CRITICAL, INFO, WARNING

Enum"CRITICAL""INFO""WARNING"
items[].​statestring
items[].​subTypestring or null

Sub-type of the insight (eg. DISK/CPU)

items[].​symptomstring or null
items[].​systemDetailsobject(SystemDetails)
items[].​systemIdstring

Identifier of the system

items[].​titlestring

One line description of the insight

items[].​valuenumber(float64)

insight values - No. of annotations, saturation value

totalinteger

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

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

volume-sets

The Volume-sets API allows the management of volume sets

Operations

volumes

The volumes API allows the management of volumes

Operations

snapshots

Operations