Skip to content
/
Get details of a host ide...

HPE Greenlake For Block Storage REST APIs. (1.1.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-public-v1alpha1/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

Generate a DH-HMAC-CHAP host key usable for NVMe In-Band Authentication for Host by {hostId}

Request

CHAP key can be generated only on NVMe/TCP host on HPE GreenLake for Block Storage 10.5.0 and later system OS versions.

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
Bodyapplication/jsonrequired
systemstringrequired

system to which NVMe/TCP initiator has connectivity

Example: "15.212.100.100"
typestringrequired

type for generate CHAP key. Allowed values are INITIATOR | TARGET.

Enum"INITIATOR""TARGET"
Example: "INITIATOR"
secretstringrequired

secret (in hexadecimal characters) to be used to initialize the key. Length of secret should be one of 64 | 96 | 128 based on hmacNum. (hmacNum, Length of secret): (NONE, 64) | (SHA256, 64) | (SHA384, 96) | (SHA512, 128)

Example: "DB174528097951E0CCF41D92476FCA228E77717F1AE82AB380FCA07A2A91ABCD"
hmacNumstring or null

HMAC function to use for key transformation. Expected values are NONE | SHA256 | SHA384 | SHA512. Default value is NONE.

Enum"NONE""SHA256""SHA384"
Example: "SHA512"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/chapkey \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "secret": "DB174528097951E0CCF41D92476FCA228E77717F1AE82AB380FCA07A2A91ABCD",
    "system": "15.212.100.100",
    "type": "INITIATOR"
  }'

Responses

Success

Bodyapplication/json
chapkeystring

Generated CHAP key for NVMe/TCP initiator

Example: "DHHC-1:00:2xdFKAl5UeDM9B2SR2/KIo53cX8a6CqzgPygeiqRq83MSNuW:"
Response
application/json
{
  "chapkey": "DHHC-1:00:2xdFKAl5UeDM9B2SR2/KIo53cX8a6CqzgPygeiqRq83MSNuW:"
}

Get details of a host identified by {hostId} across its associated systems

Request

Get details of a host identified by {hostId} across its associated systems

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/mapped-devices \
  -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(MappedDevice)required
items[].​idstringrequired

Identifier for an host/hostgroup.

Example: "d548ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

The type of resource.

Example: "initiator"
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​mappedDevicesArray of objects or null(MappedDeviceDetails)
items[].​namestring

Name of the host/hostgroup.

Example: "init1"
totalinteger

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

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

Get the volume performance history data associated with a host identified by {uid}

Request

Get the volume performance history data associated with a host identified by {uid}

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
Query
selectstring

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

Example: select=latencyMetricsDataMs
rangestring

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

Example: range=startTime eq 1605063600 and endTime eq 1605186000
time-interval-mininteger

It defines granularity in minutes.

Enum5601440
Example: time-interval-min=1440
top-volumes-countinteger

The number of top volumes to return. Defaults to 5.

Example: top-volumes-count=5
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/storage-performance-history \
  -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(hostStoragePerformanceHistory)required
items[].​idstringrequired

ID of the resource

Example: "e66ed5ce8d35961481a48b4f78bb06b4"
items[].​typestringrequired

type

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

customerId

Example: "string"
items[].​hostVolumePerfTrendDataobject or null(hostHistoryData)
totalinteger

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

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

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

snapshots

Operations