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

host-sets

The ports API allows the management of host-sets

Operations

Get details of HPE Alletra Storage MP B10000 Host Sets

Request

Get details of HPE Alletra Storage MP B10000 Host Sets

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 set by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

sortstring

oData query to sort host set 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-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(DeviceType4HostSetListObj)required

items[].idstringrequired

HostSet Resource UID Filter

Example: "1223f5s"

items[].typestringrequired

Type of the resource

items[].associatedLinksArray of objects or null

Associated Links Details

items[].commentstring or null

Comment on the Host Set

Example: "hostset comment"

items[].commonResourceAttributesobject or null(commonResourceAttributesDeviceType4HostSet)

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 Set

Example: "slt"

items[].generationinteger(Uint64)

Generation Time of the Resource Filter, Sort

Example: 101780

items[].hostSetIdinteger or null(Uint64)

Numeric ID of the resource

Example: 101780

items[].membersArray of strings or null or null

system ntp addresses Filter, Sort

items[].namestring or null

Host Set Name Filter, Sort

Example: "test-host-set"

items[].resourceUristring or null

resourceUri for detailed hostset object

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

items[].scHostGroupIdstring or null

Host Service HostGroup Id Filter

Example: "1223f5s"

items[].systemUidstring

Serail Number of the system Filter

Example: "swK21"

items[].systemWwnstring

System wwn Filter, Sort

Example: "swK21"

items[].uristring or null

Uri

Example: "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec"

items[].uuidstring

HostSet Resource UUID

Example: "1223f5s"

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 Set identified by {HostSetId}

Request

Get details of HPE Alletra Storage MP B10000 Host Set identified by {HostSetId}

Security

bearer

Path

systemIdstringrequired

systemId of the storage system

Example: 7CE751P312

hostSetIdstringrequired

ID of the HPE Alletra Storage MP B10000 Host Set. 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-sets/2a0df0fe6f7dc7bb16000000000000000000004817 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

HostSet Resource UID

Example: "1223f5s"

typestringrequired

Type of the resource

associatedLinksArray of objects or null

Associated Links Details

commentstring or null

Comment on the Host Set

Example: "hostset comment"

commonResourceAttributesobject or null(commonResourceAttributesDeviceType4HostSet)

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 Set

Example: "slt"

generationinteger(Uint64)

Generation Time of the Resource

Example: 101780

hostSetIdinteger or null(Uint64)

Numeric ID of the resource

Example: 101780

membersArray of strings or null or null

system ntp addresses

namestring or null

Host Set Name

Example: "test-host-set"

resourceUristring or null

resourceUri for detailed hostset object

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

scHostGroupIdstring or null

Host Service HostGroup Id

Example: "1223f5s"

systemUidstring

Serail Number of the system

Example: "swK21"

systemWwnstring

System wwn

Example: "swK21"

uristring or null

Uri

Example: "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec"

uuidstring

HostSet Resource UUID

Example: "1223f5s"

Response

application/json

{
  "associatedLinks": [
    { … }
  ],
  "comment": "hostset comment",
  "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": "slt",
  "generation": 101780,
  "hostSetId": 101780,
  "id": "1223f5s",
  "members": [
    "string"
  ],
  "name": "test-host-set",
  "resourceUri": "/v1/storage-systems/host-setss/dbce79b2612cde02a6e0be8934c330ec",
  "scHostGroupId": "1223f5s",
  "systemUid": "swK21",
  "systemWwn": "swK21",
  "type": "string",
  "uri": "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec",
  "uuid": "1223f5s"
}

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

host-sets

Get details of HPE Alletra Storage MP B10000 Host Sets

Request

Responses

Was this helpful?

Get details of HPE Alletra Storage MP B10000 Host Set identified by {HostSetId}

Request

Responses

Was this helpful?

hosts

storage-pools

storage-systems

volume-sets

volumes

snapshots