Skip to content
/enclosures

Storage Fleet REST APIs (1.0.0)

Storage Fleet REST APIs

Download OpenAPI description
storage-fleet-api.json
storage-fleet-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/storage-fleet/public/openapi/storage-fleet-public-v1alpha1/storage-fleet-api/

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

Get all enclosures of a HPE Alletra Storage X10000 system

Request

Get all enclosures of a HPE Alletra Storage X10000 system

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
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
selectstring

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

Example: select=id
filterstring

Lucene query to filter Enclosures by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004007
sortstring

Data query to sort Enclosure resource by Key.

Example: sort=id desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/enclosures \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects or nullrequired
items[].​idstringrequired

Identifier of the Storage system Enclosure. Filter, Sort

Example: "default.enclosure-0"
items[].​typestringrequired

Type of the resource.

Example: "enclosure"
items[].​apiVersionstring or null

API version of the resource.

Example: "sc.hpe.com/v1"
items[].​assemblySerialNumberstring or null

The Assembly serial number of the Enclosure.

Example: "FDBCVFU6578DGF"
items[].​associatedLinksArray of objects or null or null(homefleetAssociatedLinks)
items[].​chassisTypestring or null

Identifies whether the Enclosure contains computer controllers or is a JBOF. Filter, Sort

Example: "Node"
items[].​clusterIdstring or null

The unique identifier of the Storage system to which the Enclosure belongs.

Example: "123abcd4-5e67-890f-g123-4hi5j67kl8m9"
items[].​clusterRefstring or null

The URI of the Storage system to which the Enclosure belongs.

Example: "/api/sc.hpe.com/v1/default/enclosures/enclosure-0"
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring or null

Customer ID for the Storage system Enclosure. Filter, Sort

Example: "ab1c23456d78901e23fghijk456lm7no"
items[].​generationinteger or null(int64)

Generation. Filter, Sort

Example: 1692945579
items[].​kindstring or null

Kind of the resource.

Example: "Enclosure"
items[].​partNumberstring or null

The part number of the Enclosure. Filter

Example: ""
items[].​resourceUristring or null(homefleetResourceUri)
items[].​serialNumberstring or null

The serial number of the Enclosure. Filter, Sort

Example: "AB1234C5D6"
items[].​statusobject or null(HomefleetEnclosureStatus)
items[].​systemIdstring or null

Identifier of the Storage system to which the Enclosure belongs. Filter, Sort

Example: "1AB234CDEF"
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

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

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

Get Enclosure of a HPE Alletra Storage X10000 system identified by enclosureID

Request

Get Enclosure of HPE Alletra Storage X10000 system identified by enclosureID

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
enclosureIdstringrequired

Identifier of Enclosure. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007
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/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/enclosures/2a0df0fe6f7dc7bb16000000000000000000004007 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
object or null(HomefleetEnclosureDetail)
Response
application/json
{
  "assemblySerialNumber": "DGFUFOV6578FH",
  "chassisType": "Node",
  "customerId": "ab1c23456d78901e23fghijk456lm7no",
  "generation": 1692945579,
  "id": "default.enclosure-0",
  "partNumber": "",
  "serialNumber": "AB1234C5D6",
  "systemId": "1AB234CDEF",
  "apiVersion": "sc.hpe.com/v1",
  "associatedLinks": [
    { … }
  ],
  "clusterId": "123abcd4-5e67-890f-g123-4hi5j67kl8m9",
  "clusterRef": "/api/sc.hpe.com/v1/default/enclosures/enclosure-0",
  "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."
  },
  "kind": "Enclosure",
  "resourceUri": "/storage-fleet/v1alpha1/devtype7-storage-systems/4UN042PTDW",
  "status": {
    "aggregateRawStorageCapacity": 120,
    "chassisSensors": [ … ],
    "conditions": [ … ],
    "disks": [ … ],
    "fanOverallStatus": "Ok",
    "ioModules": [ … ],
    "lastModifiedTime": "2023-08-24T07:14:33Z",
    "locatorLedState": "Off",
    "logicalClusterSerialNumber": "ABGFDYRKJ1",
    "observedGeneration": 8,
    "psuOverallStatus": "Ok",
    "ready": true,
    "tempOverallStatus": "Ok"
  },
  "type": "enclosure"
}

Edit settings of HPE Alletra Storage X10000 system Enclosure identified by {enclosureId}

Request

Edit settings of HPE Alletra Storage X10000 system Enclosure identified by {enclosureId}

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
enclosureIdstringrequired

Identifier of Enclosure. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007
Bodyapplication/jsonrequired
locatorLedStatestring

The desired state of the locator LED on the enclosure.Possible Values: 'On', 'Off'

Example: "On"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/enclosures/2a0df0fe6f7dc7bb16000000000000000000004007 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

jbofioms

The JBOF IOM API provides endpoints for managing and configuring JBOF IOMs.

Operations

storage-nodes

The Storage Node API provides endpoints for managing and configuring storage nodes.

Operations

storage-systems

The storage-systems API allows the management of storage device.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations