Get storage system object identified by {id}

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

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

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

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 the management of storage device.

Operations

Get all storage systems

Request

Get all storage systems

Security

bearer

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

Example: filter=name eq VEGA_CB1507_8400_2N_150

sortstring

Query to sort the response with specified key and order

Example: sort=id asc,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/storage-systems \
  -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(storageSystemDetailList)required

items[].idstringrequired

UUID string uniquely identifying the storage system object.

Example: "7CE751P312"

items[].typestringrequired

type

Example: "string"

items[].arrayListArray of objects or null or null(NimbleArraySummary)

The list of Nimble arrays part of this system.

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

items[].callhomeStatusstring

Device Call-home connectivity status.

Enum"ENABLED_NORMAL""ENABLED_DEGRADED""DISABLED"

Example: "ENABLED_NORMAL"

items[].commonResourceAttributesobject or null(commonResourceAttributesfleet)

items[].customerIdstring or null

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"

items[].descriptionstring or null<= 255 characters

A brief description of the storage system.

items[].fqdnstring or null

Fully qualified domain name of the array

Example: "s9.in.hpecorp.net"

items[].generationinteger or null

generation

Example: 0

items[].lastConnectedTimeinteger or null(lastConnectedTime)

items[].maxVolumeDecoSizeMibstring or null

Maximum supported size for a DECO volume. This is applicable for HPE Alletra Storage MP 10.4.0, HPE Primera 4.6.0 and HPE Alletra 9K 9.6.0 and later system OS versions.

Example: "67108864"

items[].mgmtIp(ip4 (string or null)) or (ip6 (string or null))(ips)

Any of:

An IP address or FQDN to address the storage system.

string or null ip4 Recursive

items[].minVolumeDecoSizeMibstring or null

Minimum supported size for a DECO volume. This is applicable for HPE Alletra Storage MP 10.4.0, HPE Primera 4.6.0 and HPE Alletra 9K 9.6.0 and later system OS versions.

Example: "256"

items[].modelstring or null

Model of the storage system Filter, Sort

items[].namestring or null

A name to identify the storage system. Filter, Sort

Example: "DeviceType1Billing"

items[].productFamilystring

Storage device type

Example: "deviceType1"

items[].resourceUristring or null

resourceUri for detailed storage object

Example: "/storage-fleet/v1alpha1/storage-systems/2FF70002AC018D94"

items[].serialNumberstring or null

Serial number of the array

Example: "CZ2D2407WM"

items[].softwareVersionstring or null

Software version of the storage system Filter, Sort

items[].statestring

For deviceType1 State derived from ports, enclosure, disk and node state for deviceType2 state is state reported by deviceType2 array

Enum"NORMAL""DEGRADED"

Example: "NORMAL"

items[].tierNamestring or null

Name of the storage tier

Example: "HPE GreenLake for Block Storage"

items[].tierTypestring or null

StorageTier.

Enum"STORAGE_TIER_9000_NVME""STORAGE_TIER_6000_NVME""STORAGE_TIER_NIMBLE_HYBRID"

Example: "STORAGE_TIER_UNKNOWN"

items[].upSinceinteger or null(int64)

The time that the system has been up since

Example: 1600084190299

totalinteger

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

Response

application/json

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

Get storage system object identified by {id}

Request

Get storage system object identified by {id}

Security

bearer

Path

idstringrequired

Serial number of the device-type4 storage system

Example: SGH029VBHV

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/storage-systems/SGH029VBHV \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

UUID string uniquely identifying the storage system object.

Example: "7CE751P312"

typestringrequired

type

Example: "string"

arrayListArray of objects or null or null(NimbleArraySummary)

The list of Nimble arrays part of this system.

associatedLinksArray of objects or null(associatedLinks)

callhomeStatusstring

Device Call-home connectivity status

Enum"ENABLED_NORMAL""ENABLED_DEGRADED""DISABLED"

Example: "ENABLED_NORMAL"

commonResourceAttributesobject or null(commonResourceAttributesfleet)

customerIdstring or null

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"

descriptionstring or null<= 255 characters

A brief description of the storage system.

fqdnstring or null

Fully qualified domain name of the system

Example: "s9.in.hpecorp.net"

generationinteger or null

generation

Example: 0

lastConnectedTimeinteger or null(lastConnectedTime)

maxVolumeDecoSizeMibstring or null

Maximum supported size for a DECO volume. This is applicable for HPE Alletra Storage MP 10.4.0, HPE Primera 4.6.0 and HPE Alletra 9K 9.6.0 and later system OS versions.

Example: "67108864"

mgmtIp(ip4 (string or null)) or (ip6 (string or null))(ips)

Any of:

An IP address or FQDN to address the storage system.

string or null ip4 Recursive

minVolumeDecoSizeMibstring or null

Minimum supported size for a DECO volume. This is applicable for HPE Alletra Storage MP 10.4.0, HPE Primera 4.6.0 and HPE Alletra 9K 9.6.0 and later system OS versions.

Example: "256"

modelstring or null

Model of the storage system

namestring or null<= 255 characters

A name to identify the storage system.

Example: "DeviceType1Billing"

productFamilystring

Storage device type

Example: "deviceType1"

resourceUristring or null

resourceUri for detailed storage object

Example: "/storage-fleet/v1alpha1/storage-systems/7CE751P312"

serialNumberstring or null

Serial number of the array

Example: "CZ2D2407WM consoleUri for detailed storage object"

softwareVersionstring or null

Software version of the storage system

statestring

For deviceType1 State derived from ports, enclosure, disk and node state for deviceType2 state is state reported by deviceType2 array

Enum"NORMAL""DEGRADED"

Example: "NORMAL"

tierNamestring or null

Name of the storage tier

Example: "HPE GreenLake for Block Storage"

tierTypestring or null

StorageTier.

Enum"STORAGE_TIER_9000_NVME""STORAGE_TIER_6000_NVME""STORAGE_TIER_NIMBLE_HYBRID"

Example: "STORAGE_TIER_UNKNOWN"

upSinceinteger or null(int64)

The time that the system has been up since

Example: 1600084190299

Response

application/json

{
  "arrayList": [
    { … }
  ],
  "associatedLinks": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "callhomeStatus": "ENABLED_NORMAL",
  "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": "fc5f41652a53497e88cdcebc715cc1cf",
  "description": "string",
  "fqdn": "s9.in.hpecorp.net",
  "generation": 0,
  "id": "7CE751P312",
  "lastConnectedTime": 1600084190299,
  "maxVolumeDecoSizeMib": "67108864",
  "mgmtIp": "192.168.0.1",
  "minVolumeDecoSizeMib": "256",
  "model": "string",
  "name": "DeviceType1Billing",
  "productFamily": "deviceType1",
  "resourceUri": "/storage-fleet/v1alpha1/storage-systems/7CE751P312",
  "serialNumber": "CZ2D2407WM consoleUri for detailed storage object",
  "softwareVersion": "string",
  "state": "NORMAL",
  "tierName": "HPE GreenLake for Block Storage",
  "tierType": "STORAGE_TIER_UNKNOWN",
  "type": "string",
  "upSince": 1600084190299
}

Get all device types

Request

Get all device types

Security

bearer

curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/storage-types \
  -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(deviceTypes)required

items[].idstringrequired

ID string uniquely identifying the object.

items[].typestringrequired

Type of the resource.

items[].descriptionstring or null

Description of the device family

Example: "HPE deviceType1 Storage"

items[].deviceTypestring

Storage Device type

Example: "deviceType1"

totalinteger

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

Response

application/json

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

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

vvolscs

Operations

HPE Greenlake For Storage Fleet REST APIs (1.2.0)

certificates

controllers

enclosures

encryption

jbofioms

object-notification-clients

ports

shelves

storage-nodes

storage-systems

Get all storage systems

Request

Responses

Was this helpful?

Get storage system object identified by {id}

Request

Responses

Was this helpful?

Get all device types

Request

Responses

Was this helpful?

switches

system-settings

vvolscs