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

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

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

Get all storage nodes of a HPE Alletra Storage X10000 system

Request

Get all storage nodes 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

filterstring

Lucene query to filter StorageNodes by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004007

sortstring

Data query to sort StorageNodes resource by Key.

Example: sort=name 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/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/storage-nodes \
  -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 or objects or null or objects or null(HomefleetStorageNode)required

items[].idstringrequired

Identifier for the Storage Node. Filter, Sort

Example: "default.node-1"

items[].typestringrequired

The type of the resource.

Example: "string"

items[].assemblySerialNumberstring or null

Assembly SerialNumber of Storage Node.

Example: "NSIRNP6ZAP90LO"

items[].customerIdstring or null

CustomerId. Filter

Example: "fc5f41652a53497e88cdcebc715cc1cf"

items[].enclosureSerialNumberstring or null

Enclosure serial number. Filter

Example: "USM2437VYZ"

items[].generationinteger or null

generation. Filter, Sort

Example: 1690454688

items[].serialNumberstring or null

SerialNumber of Storage Node. Filter, Sort

Example: "StorageNode9801"

items[].systemIdstring or null

System Id of the Storage Node. Filter, Sort

Example: "4UN042PTDW"

items[].apiVersionstring or null

apiVersion

Example: "sc.hpe.com/v1"

items[].associatedLinksArray of objects or null or null(homefleetAssociatedLinks)

items[].backendPortsArray of objects or null or null(PortDetails)

items[].clusterIdstring or null

Id of the Storage system

Example: "4ab3ad16-770e-4db8-b6a3-5ae267420f86"

items[].clusterRefstring or null

Reference of the Storage system

Example: "/api/sc.hpe.com/v1/default/storage/system-1"

items[].commonResourceAttributesobject or null(commonResourceAttrs)

items[].coreDnsNamestring or null

Core DNS Name

Example: "node-NDBAEL2BHT17DI.node.local"

items[].enclosureIdstring or null

enclosur Id of the node

Example: "59409cc2-77d4-4a32-b979-59a9fa339fc1"

items[].enclosureRefstring or null

enclosureRef

Example: "/api/sc.hpe.com/v1/default/enclosure-1/Enclosure"

items[].frontendPortsArray of objects or null or null(PortDetails)

items[].kindstring or null

kind of object

Example: "FleetOsNode"

items[].locationstring or null

location of the resource in enclosure.

Example: "0"

items[].partNumberstring or null

partNumber

Example: "HFSCURHF897"

items[].resourceUristring or null(homefleetResourceUri)

items[].statusobject or null(NodeStatus)

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get StorageNode of a HPE Alletra Storage X10000 system identified by storageNodeID

Request

Get StorageNode of a HPE Alletra Storage X10000 system identified by storageNodeID

Security

bearer

Path

storageNodeIdstringrequired

Identifier of StorageNode. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007

systemIdstringrequired

ID of the storage system

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

Responses

Success

Bodyapplication/json

object or null(HomefleetStorageNodeDetails)

Response

application/json

{
  "assemblySerialNumber": "DGFUFOV6578FH",
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "enclosureSerialNumber": "USM2437VYZ",
  "generation": 1690454688,
  "id": "default.node-1",
  "serialNumber": "StorageNode9801",
  "systemId": "4UN042PTDW",
  "type": "string",
  "apiVersion": "sc.hpe.com/v1",
  "associatedLinks": [
    { … }
  ],
  "backendPorts": [
    { … }
  ],
  "clusterId": "4ab3ad16-770e-4db8-b6a3-5ae267420f86",
  "clusterRef": "/api/sc.hpe.com/v1/default/storage/system-1",
  "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."
  },
  "coreDnsName": "node-NDBAEL2BHT17DI.node.local",
  "enclosureId": "59409cc2-77d4-4a32-b979-59a9fa339fc1",
  "enclosureRef": "/api/sc.hpe.com/v1/default/enclosure-1/Enclosure",
  "frontendPorts": [
    { … }
  ],
  "kind": "FleetOsNode",
  "location": "0",
  "partNumber": "HFSCURHF897",
  "resourceUri": "/storage-fleet/v1alpha1/devtype7-storage-systems/4UN042PTDW",
  "status": {
    "auditPolicy": { … },
    "backendNics": [ … ],
    "conditions": [ … ],
    "dnsServers": [ … ],
    "faultLedState": "15.213.204.163",
    "frontendNics": [ … ],
    "healthLedState": "Off",
    "hostname": "c0n2",
    "jbofConnectivityStatuses": [ … ],
    "lastModifiedTime": "2023-07-26T21:15:27Z",
    "managementInterface": { … },
    "observedGeneration": 3,
    "operationalState": "Online",
    "osVersion": "0.0.4870.0-1037280",
    "outboundProxy": { … },
    "ready": true,
    "strongPasswordMode": { … }
  }
}

Edit settings of a HPE Alletra Storage X10000 system Storage Node identified by storageNodeID

Request

Edit settings of a HPE Alletra Storage X10000 system Storage Node identified by storageNodeID

Security

bearer

Path

systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817

storageNodeIdstringrequired

Identifier of StorageNode. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007

Bodyapplication/jsonrequired

frontendNicsArray of objects or null or null(FrontendNICInputDetails)

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/storage-nodes/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"
}

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

Storage Fleet REST APIs (1.0.0)

enclosures

jbofioms

storage-nodes

Get all storage nodes of a HPE Alletra Storage X10000 system

Request

Responses

Was this helpful?

Get StorageNode of a HPE Alletra Storage X10000 system identified by storageNodeID

Request

Responses

Was this helpful?

Edit settings of a HPE Alletra Storage X10000 system Storage Node identified by storageNodeID

Request

Responses

Was this helpful?

storage-systems

switches

Storage Fleet REST APIs (1.0.0)

enclosures

jbofioms

storage-nodes

Get all storage nodes of a HPE Alletra Storage X10000 system

Request

Responses

Was this helpful?

Get StorageNode of a HPE Alletra Storage X10000 system identified by storageNodeID

Request

Responses

Was this helpful?

Edit settings of a HPE Alletra Storage X10000 system Storage Node identified by storageNodeID

RequestExpand all

Responses

Was this helpful?

storage-systems

switches

Request