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

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

host-paths

The ports API allows the management of host-paths

Operations

Get details of HPE Alletra Storage MP B10000 Host Paths

Request

Get details of HPE Alletra Storage MP B10000 Host Paths

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

Lucene query to filter host path by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

sortstring

oData query to sort host path resource by Key.

Example: sort=HostSpeed 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/devtype4-storage-systems/7CE751P312/host-paths \
  -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(DeviceType4HostPathListObj)required

items[].idstringrequired

HostPath Resource UID Filter

Example: "1223f5s"

items[].typestringrequired

type

items[].addressstring or null

WWN Address of the Host Path Filter

Example: "810009440c9ce5824"

items[].associatedLinksArray of objects or null

Associated Links Details

items[].commonResourceAttributesobject or null(commonResourceAttributesDeviceType4HostPath)

items[].displaynamestring or null

Name to be used for display purposes

Example: "Drive 0.SIDE_NONE.2.0"

items[].domainstring or null

Domain name of the Host

Example: "-"

items[].driverVersionstring or null

Driver version

Example: "v1.0.0"

items[].firmwareVersionstring or null

Firmware version

Example: "v1.0.0"

items[].generationinteger(Uint64)

Generation Time of the Resource Filter, Sort

Example: 1652172206

items[].hostIdinteger or null(Uint64)

ID of the Host resource

Example: 101780

items[].hostNamestring or null

Host Name Filter, Sort

Example: "test-host"

items[].hostSpeedinteger or null(Any)

ID of the Host resource

Example: 100

items[].ipAddrstring or null

Ip Address

Example: "1.1.1.1"

items[].modelstring or null

Host Model

Example: "model_1"

items[].nvmeSubsystemNqnstring or null

Subsystem NQN of NVMe/TCP hostpath

Example: "nqn.2020-07.com.hpe:8ee43ce5-8264-4fcf-9990-a894f56386c7"

items[].pathTypestring or null

Path Type Filter

Example: "FC"

items[].portPosobject or null

items[].resourceUristring or null

resourceUri for detailed hostpath object

Example: "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec"

items[].scHostInitiatorIdstring or null

Host Service Initiator Id Filter

Example: "1223f5s"

items[].switchPortWwnstring or null

Switch Port WWN

Example: "5001438026e98a60"

items[].systemUidstring

System Uid Filter

Example: "7CE727P35M"

items[].systemWwnstring

System serial Number Filter, Sort

Example: "swK21"

items[].uristring or null

Uri

Example: "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec"

items[].vendorstring or null

Vendor

Example: "-"

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 HPE Alletra Storage MP B10000 Host Path identified by {HostPathId}

Request

Get details of HPE Alletra Storage MP B10000 Host Path identified by {HostPathId}

Security

bearer

Path

systemIdstringrequired

systemId of the storage system

Example: 7CE751P312

hostPathIdstringrequired

ID of the HPE Alletra Storage MP B10000 Host Path. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004817

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/v1alpha1/devtype4-storage-systems/7CE751P312/host-paths/2a0df0fe6f7dc7bb16000000000000000000004817 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

HostPath Resource UID

Example: "1223f5s"

typestringrequired

type of the resource

addressstring or null

WWN Address of the Host Path

Example: "810009440c9ce5824"

associatedLinksArray of objects or null

Associated Links Details

commonResourceAttributesobject or null(commonResourceAttributesDeviceType4HostPath)

displaynamestring or null

Name to be used for display purposes

Example: "Drive 0.SIDE_NONE.2.0"

domainstring or null

Domain name of the Host

Example: "-"

driverVersionstring or null

Driver version

Example: "v1.0.0"

firmwareVersionstring or null

Firmware version

Example: "v1.0.0"

generationinteger(Uint64)

Generation Time of the Resource

Example: 1652172206

hostIdinteger or null(Uint64)

ID of the Host resource

Example: 101780

hostNamestring or null

Host Name

Example: "test-host"

hostSpeedinteger or null(Any)

ID of the Host resource

Example: 100

ipAddrstring or null

Ip Address

Example: "1.1.1.1"

modelstring or null

Host Model

Example: "model_1"

nvmeSubsystemNqnstring or null

Subsystem NQN of NVMe/TCP hostpath

Example: "nqn.2020-07.com.hpe:8ee43ce5-8264-4fcf-9990-a894f56386c7"

pathTypestring or null

Path Type

Example: "FC"

portPosobject or null

resourceUristring or null

resourceUri for detailed hostpath object

Example: "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec"

scHostInitiatorIdstring or null

Host Service Initiator Id

Example: "1223f5s"

switchPortWwnstring or null

Switch Port WWN

Example: "5001438026e98a60"

systemUidstring

System Uid

Example: "7CE727P35M"

systemWwnstring

System serial Number

Example: "swK21"

uristring or null

Uri

Example: "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec"

vendorstring or null

Vendor

Example: "-"

Response

application/json

{
  "address": "810009440c9ce5824",
  "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."
  },
  "displayname": "Drive 0.SIDE_NONE.2.0",
  "domain": "-",
  "driverVersion": "v1.0.0",
  "firmwareVersion": "v1.0.0",
  "generation": 1652172206,
  "hostId": 101780,
  "hostName": "test-host",
  "hostSpeed": 100,
  "id": "1223f5s",
  "ipAddr": "1.1.1.1",
  "model": "model_1",
  "nvmeSubsystemNqn": "nqn.2020-07.com.hpe:8ee43ce5-8264-4fcf-9990-a894f56386c7",
  "pathType": "FC",
  "portPos": {
    "node": 1,
    "port": 1,
    "slot": 1
  },
  "resourceUri": "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec",
  "scHostInitiatorId": "1223f5s",
  "switchPortWwn": "5001438026e98a60",
  "systemUid": "7CE727P35M",
  "systemWwn": "swK21",
  "type": "string",
  "uri": "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec",
  "vendor": "-"
}

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

HPE Greenlake For Block Storage REST APIs. (1.0.0)

host-initiator-groups

host-initiators

host-paths

Get details of HPE Alletra Storage MP B10000 Host Paths

Request

Responses

Was this helpful?

Get details of HPE Alletra Storage MP B10000 Host Path identified by {HostPathId}

Request

Responses

Was this helpful?

host-sets

hosts

storage-pools

storage-systems

volume-sets

volumes

snapshots