Skip to content

HPE Greenlake For Storage Fleet REST APIs (1.4.0)

HPE Greenlake For 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/

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

Get CPU performance metrics for nodes on storage system identified by {systemId} for device type 4

Request

Get CPU performance metrics for nodes on storage system identified by {systemId} for device type 4

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
report-viewstring

parameter will be set to report view requested. For api users, set parameter as ApiUser

Example: report-view=Canned,Custom,Def,ApiUser
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=60
compare-bystring

compareBy will define top and compare metrics for which query has to be made. Allowed value: cpu_percentage

Example: compare-by=top eq 5 and metrics eq cpu_percentage
componentstring

component will give information about resource to be queried for CPU performance

Value"NODECPU"
Example: component=NODECPU
metric-typestring

metricType for CPU performance metrics

Example: metric-type=CPU_PERCENTAGE
filterstring

filter will define objects to be filtered for CPU performance. Filterable column:

  • nodeId - id of the node
Example: filter=nodeId in (0, 1)
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/cpu-performance \
  -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(DeviceType4CpuPerformanceHistoryData)required
items[].​idstringrequired

Identifier for the node.

Example: "0"
items[].​typestringrequired

type

Example: "storage-systems/cpu-performance-history"
items[].​commonResourceAttributesobject or null(commonResourceAttributesPerf)
items[].​cpuUsagePercentageobject or null(DeviceType4CpuUsagePercentageData)
items[].​customerIdstring or null

customerId

Example: "tenant-12345"
items[].​metricsEndTimeSecondsinteger or null

end time of history data

Example: 1732233600
items[].​metricsStartTimeSecondsinteger or null

start time of history data

Example: 1732147200
items[].​nodeNamesArray of strings

List of node names contributing to this metric data

Example: ["Node-0","Node-1"]
items[].​systemIdstring or null

Storage system ID

Example: "2M286039GJ"
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 Nodes

Request

Get details of HPE Alletra Storage MP B10000 Nodes

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

oData query to filter nodes resource by key.

Example: filter=systemUid eq 7CE751P312
sortstring

oData query to sort nodes resource by key.

Example: sort=systemId 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/devtype4-storage-systems/7CE751P312/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(DeviceType4nodesList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null(DeviceType4nodeAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​displaynamestring or null

Name to be used for display purposes

Example: "Controller Node 0"
items[].​domainstring or null

Domain that the resource belongs to

Example: null
items[].​enclosureCardIdinteger or null

ID of the enclosure card

items[].​enclosureCardUidstring or null

Unique Identifier of the enclosure card Filter

items[].​enclosureIdinteger or null

ID of the enclosure

items[].​enclosureUidstring or null

Unique Identifier of the enclosure Filter

items[].​generationinteger or null

generation Filter, Sort

Example: 0
items[].​inClusterboolean or null

Indicates if this node is part of the cluster.

Example: true
items[].​kernelVersionstring or null

Kernel version

Example: "4.2.1"
items[].​masterboolean or null

Indicates if this is the master node.

Example: true
items[].​memoryMiBinteger or null

Total data memory in the node in MiB

Example: 5
items[].​namestring or null<= 255 characters

Name of the resource. Filter, Sort

Example: "4UW0002941-0"
items[].​nodeIdinteger or null(int64)

Numeric ID of the resource.

Example: 0
items[].​onlineboolean or null

Indicates if this node is online

Example: true
items[].​resourceUristring or null

resourceUri for detailed node object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5"
items[].​stateobject or null(DeviceType4State)
items[].​systemIdstring or null

SystemId/serialNumber of the array.

Example: "7CE751P312"
items[].​uptimeobject or null(DeviceType4uptime)
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 Node identified by {id}

Request

Get details of HPE Alletra Storage MP B10000 Node identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the node

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource.

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null(DeviceType4nodeAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
displaynamestring or null

Name to be used for display purposes

Example: "Controller Node 0"
domainstring or null

Domain that the resource belongs to

Example: null
enclosureCardIdinteger or null

ID of the enclosure card

enclosureCardUidstring or null

Unique Identifier of the enclosure card

enclosureIdinteger or null

ID of the enclosure

enclosureUidstring or null

Unique Identifier of the enclosure

generationinteger or null

generation

Example: 0
inClusterboolean or null

Indicates if this node is part of the cluster.

Example: true
kernelVersionstring or null

Kernel version

Example: "4.2.1"
masterboolean or null

Indicates if this is the master node.

Example: true
memoryMiBinteger or null

Total data memory in the node in MiB

Example: 5
namestring or null<= 255 characters

Name of the resource.

Example: "4UW0002941-0"
onlineboolean or null

Indicates if this node is online

Example: true
resourceUristring or null

resourceUri for detailed node object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5"
stateobject or null(DeviceType4State)
systemIdstring or null

SystemId/Serial Number of the array.

Example: "7CE751P312"
uptimeobject or null(DeviceType4uptime)
Response
application/json
{
  "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."
  },
  "customerId": "string",
  "displayname": "Controller Node 0",
  "domain": null,
  "enclosureCardId": 0,
  "enclosureCardUid": "string",
  "enclosureId": 0,
  "enclosureUid": "string",
  "generation": 0,
  "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  "inCluster": true,
  "kernelVersion": "4.2.1",
  "master": true,
  "memoryMiB": 5,
  "name": "4UW0002941-0",
  "online": true,
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "systemId": "7CE751P312",
  "type": "string",
  "uptime": {
    "ms": 123423423,
    "tz": "IST"
  }
}

Locate node of HPE Alletra Storage MP B10000 identified by {id}

Request

Locate node of HPE Alletra Storage MP B10000 identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the node

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
Bodyapplication/jsonrequired
locateboolean

Indicates if the locate beacon should be enabled or not

Example: true
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -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"
}

Get component performance statistics details of HPE Alletra Storage MP B10000 node identified by {nodeId}

Request

Get component performance statistics details of HPE Alletra Storage MP B10000 node identified by {nodeId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
nodeIdstringrequired

UID of the node

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/component-performance-statistics \
  -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(DeviceType4NodePerfStats)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​cachePercentageobject or null(DeviceType4perfData)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​cpuPercentageobject or null(DeviceType4perfData)
items[].​customerIdstring or null

customerId

Example: "string"
totalinteger

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

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

Halt HPE Alletra Storage MP B10000 node identified by {nodeId}

Request

Shutdown should only be performed when service is required on this node. After shutdown, the node must be physically power‑cycled to restart. Shutting down the node will degrade system performance and may cause a service outage if host connectivity is not properly configured. Access to the storage system node via DSCC will be unavailable until the node is fully restored

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
nodeIdstringrequired

UID of the node

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/halt \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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"
}

Reboot HPE Alletra Storage MP B10000 node identified by {nodeId}

Request

Rebooting this node will temporarily degrade performance and may cause an outage if host connectivity is not properly configured. Access to the storage system node via DSCC will be unavailable during the reboot

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
nodeIdstringrequired

UID of the node

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/reboot \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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"
}

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

encryption

The encryption API allows the actions on encryption.

Operations

jbofioms

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

Operations

migrations

The Migrations API allows the management of data migration from source storage systems.

Operations

object-notification-clients

The Object Notification Client API provides endpoints for managing and configuring object notification clients.

Operations

ports

The ports API allows the management of ports.

Operations

protection-policies

Protection policy APIs

Operations

protection-software-update-policies

Protection and Software update policy APIs

Operations

setup-blueprints

Blueprint Service API

Operations

setup-devices

Setup Orchestrator API

Operations

shelves

The shelves API allows the management of shelves.

Operations

storage-nodes

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

Operations

storage-systems

The storage-systems API allows management of storage devices.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

system-settings

The system settings API allows the monitoring of system settings for the device.

Operations

filesystems

Operations

vvolscs

Operations