Skip to content
/storage-systems

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

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

Get all HPE Alletra Storage X10000 system

Request

Get all HPE Alletra Storage X10000 system

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

Lucene query to filter systems by Key.

Example: filter=NAME eq g1a1
sortstring

Lucene query to sort systems 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 \
  -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 nullrequired
items[].​idstringrequired

Unique identifier for the Storage system. Filter, Sort

Example: "ASHBFY6567YGHJ"
items[].​typestringrequired

The type of the resource.

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

API version Details.

Example: "sc.hpe.com/v1"
items[].​associatedLinksArray of objects or null or null(StorageClusterAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring or null

CustomerID for the Storage system. Filter

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

The most recent specification that has been observed by the controller. Filter, Sort

Example: 1690045300
items[].​kindstring or null

Kind of the resource

Example: "enclosures"
items[].​logicalClusterSerialNumberstring

10-digit identifier. This can serve as alternate Key for the resource. The value is fixed and immutable.

Example: "ABGFDYRKJ1"
items[].​resourceUristring or null

resourceUri for detailed Storage object

Example: "/storage-fleet/v1alpha1/devtype7-storage-systems/7CE751P312/"
items[].​statusobject or null(StorageCluster)
items[].​systemIdstring or null

Identifier of the Storage system. Filter, Sort

Example: "USE603C8P1"
totalinteger

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

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

Get HPE Alletra Storage X10000 system identified by {systemId}

Request

Get HPE Alletra Storage X10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
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/USE603C8P1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier for the Storage system.

Example: "ASHBFY6567YGHJ"
typestringrequired

The type of the resource.

Example: "group"
apiVersionstring or null

API version Details.

Example: "sc.hpe.com/v1"
associatedLinksArray of objects or null or null(StorageClusterAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttrs)
customerIdstring or null

CustomerID for the Storage system.

Example: "ASHBFDJHFB6567YGHJ"
generationinteger or null(int64)

The most recent specification that has been observed by the controller.

Example: 1690045300
kindstring or null

Kind of the resource

Example: "enclosures"
logicalClusterSerialNumberstring

10-digit identifier. This can serve as alternate Key for the Storage system resource. The value is fixed and immutable.

Example: "ABGFDYRKJ1"
resourceUristring or null

resourceUri for detailed Storage object

Example: "/storage-fleet/v1alpha1/devtype7-storage-systems/7CE751P312/"
statusobject or null(StorageCluster)
systemIdstring or null

Identifier of the Storage system.

Example: "USE603C8P1"
Response
application/json
{
  "apiVersion": "sc.hpe.com/v1",
  "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": "ASHBFDJHFB6567YGHJ",
  "generation": 1690045300,
  "id": "ASHBFY6567YGHJ",
  "kind": "enclosures",
  "logicalClusterSerialNumber": "ABGFDYRKJ1",
  "resourceUri": "/storage-fleet/v1alpha1/devtype7-storage-systems/7CE751P312/",
  "status": {
    "auditPolicy": { … },
    "autoSupport": "On",
    "backendSubnets": [ … ],
    "clusterManagementDnsName": "usr1",
    "clusterManagementIpAddress": "10.0.0.11",
    "clusterManagementSubnetAddress": "255.255.255.0",
    "clusterManagementSubnetDefaultGateway": "255.255.255.1",
    "clusterName": "mip-01",
    "conditions": [ … ],
    "dnsServers": [ … ],
    "dnsSubdomain": "10.0.1.17",
    "lastModifiedTime": "2023-07-26T06:50:10Z",
    "ntpServers": [ … ],
    "observedGeneration": 25,
    "outboundProxy": { … },
    "presentationTimeZone": "US/East-Indiana",
    "ready": true,
    "s3FrontEndConfiguration": { … },
    "strongPasswordMode": "Password Mode",
    "supportContact": { … },
    "supportTunnel": "On"
  },
  "systemId": "USE603C8P1",
  "type": "group"
}

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

Request

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

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
Bodyapplication/jsonrequired
auditPolicyobject or null(AuditPolicyConfiguration)
autoSupportstring or null

Current status of the auto-support setting. {"On", "Off"}

Example: "On"
clusterManagementDnsNamestring or null

Storage system Management DNS Name

Example: "usr1"
clusterManagementIpAddressstring or null

Storage system Management IPAddress.

Example: "10.0.0.11"
clusterManagementSubnetAddressstring or null

Subnet Address of Storage system Management .

Example: "255.255.255.0"
clusterManagementSubnetDefaultGatewaystring or null

Default gateway of Storage system Management.

Example: "255.255.255.1"
clusterNamestring or null

Name of the Storage System.

Example: "mip-01"
dnsServersArray of strings or null

IP addresses for this Storage system dns servers. List of IP Addresses.

forceboolean

Ignore warnings and forcibly merge specified group with this group. Possible values: 'true', 'false'.

Example: true
ntpServersArray of strings or null

IP addresses for this Storage system NTP servers. List of IP Addresses.

outboundProxyobject or null(OutboundProxyDetails)
presentationTimeZonestring or null

The Time Zone to use for presenting times to the end user in the user interface.

Example: "US/East-Indiana"
s3FrontEndConfigurationobject or null(S3FrontEndConfiguration)
supportContactobject or null(SupportDetails)
supportTunnelstring or null

User-configurable to turn on/off support engineer tunnel access into the Storage system.

Example: "On"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1 \
  -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 capacity trend data for a HPE Alletra Storage X10000 system

Request

Get capacity trend data for a HPE Alletra Storage X10000 system

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
Query
selectstring

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

Example: select=id
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
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/capacity-history \
  -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(hfCapacityHistory)required
items[].​idstringrequired

Identifier for the resource.

items[].​typestringrequired

type

Example: "Type of the resource"
items[].​capacityDataobject or null
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cp"
items[].​endTimeinteger or null

End time of the capacity history

Example: 1625209133
items[].​startTimeinteger or null

Start time of the capacity history

Example: 1625122733
totalinteger

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

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

Get capacity summary for a HPE Alletra Storage X10000 system

Request

Get capacity summary for a HPE Alletra Storage X10000 system

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
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/7CE751P312/capacity-summary \
  -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(hfSystemCapacityListSummary)required
items[].​idstringrequired

ID string uniquely identifying the object.

items[].​typestringrequired

type

Example: "Type of the resource"
items[].​associatedLinksArray of objects or null or null(homefleetAssociatedLinks)
items[].​capacitySummaryobject or null(HfSystemCapacitySummary)
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cp"
items[].​resourceUristring or null

resourceUri for detailed Storage object

Example: "/storage-fleet/v1alpha1/devtype7-storage-systems/7CE751P312/capacity-summary"
items[].​systemIdstring or null

SystemId of the storage-system.

Example: "7CE751P312"
totalinteger

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

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

Get performance trend data for a HPE Alletra Storage X10000 system

Request

Get performance trend data for a HPE Alletra Storage X10000 system

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
Query
selectstring

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

Example: select=id
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
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/performance-history \
  -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(hfPerformanceHistory)required
items[].​idstringrequired

Identifier for the resource.

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

type

Example: "Type of the resource"
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cp"
items[].​endTimeinteger or null

end time of history data

Example: 162564271
items[].​historyDataobject or null(perfHistoryData)
items[].​startTimeinteger or null

start time of history data

Example: 1625556314
totalinteger

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

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

Get SMTP settings of HPE Alletra Storage X10000 system identified by {systemId}

Request

Get SMTP settings of HPE Alletra Storage X10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
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/USE603C8P1/smtp-settings \
  -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(SMTPSettingsDetails)required
items[].​idstringrequired

Unique identifier for the Storage system.

Example: "ASHBFY6567YGHJ"
items[].​typestringrequired

type

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

API version Details.

Example: "sc.hpe.com/v1"
items[].​associatedLinksArray of objects or null or null(homefleetAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring or null

CustomerID for the Storage system.

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

The most recent specification that has been observed by the controller.

Example: 1690045300
items[].​kindstring or null

Kind of the resource

Example: "smtpSettings"
items[].​resourceUristring or null(homefleetResourceUri)
items[].​statusobject or null
items[].​systemIdstring or null

Identifier of the Storage system.

Example: "USE603C8P1"
totalinteger

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

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

Edit settings of HPE Alletra Storage X10000 system SMTP server identified by {systemId}

Request

Edit settings of HPE Alletra Storage X10000 system SMTP server identified by {systemId}

Security
bearer
Path
systemIdstringrequired

ID of the Storage system

Example: USE603C8P1
Bodyapplication/jsonrequired
credentialsobject or null(CredentialsDetails)
encryptionstring or null

The encryption to use for sending mail to the SMTP server. Accepted values:{"None", "StartTLS", "SSL/TLS" }

Example: "StartTLS"
recipientEmailAddressesArray of strings or null

The email addresses to use for the recipients of SMTP messages from the system.

Example: ["sender@email.com"]
senderEmailAddressstring or null

The address from which email from the system should should be sent. (The "From" Address)

Example: "sender@email.com"
smtpPortinteger or null(int64)

The port to which SMTP messages should be sent on the server.

Example: 586
smtpServerstring or null

SMTP server for sending email notifications.

Example: "smtp.com"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/USE603C8P1/smtp-settings \
  -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 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 above 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 above 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-type1 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 above 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 above 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