HPE Greenlake For Block Storage REST APIs. (1.0.0)

HPE Greenlake For Block Storage REST APIs.

Download OpenAPI description

block-storage-api.json

block-storage-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/block-storage/public/openapi/block-storage-public-v1alpha1/block-storage-api/

host-initiator-groups

The Host service API allows the management of Host Group

Operations

host-initiators

The Host service API allows the management of Host, initiators

Operations

host-paths

The ports API allows the management of host-paths

Operations

host-sets

The ports API allows the management of host-sets

Operations

hosts

The ports API allows the management of hosts

Operations

storage-pools

The pools API allows the management of storage pools

Operations

storage-systems

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

Operations

volume-sets

The Volume-sets API allows the management of volume sets

Operations

volumes

The volumes API allows the management of volumes

Operations

snapshots

Operations

Get the details of all read-write parent snapshots and base volume to which the child snapshot identified by {childSnapshotId} can be restored on HPE Alletra Storage MP B10000 system identified by {systemId}.

Request

Get the details of all read-write parent snapshots and base volume to which the child snapshot identified by {childSnapshotId} can be restored on HPE Alletra Storage MP B10000 system identified by {systemId}.

Security

bearer

Path

systemIdstringrequired

systemId of the storage system

Example: 7CE751P312

childSnapshotIdstringrequired

UID of the child snapshot to be restored

Example: c7c4e6593f51d0b98f0e40d7e6df04fd

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

Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

sortstring

oData query to sort by Key.

Example: sort=systemWWN 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/block-storage/v1alpha1/devtype4-storage-systems/7CE751P312/snapshots/c7c4e6593f51d0b98f0e40d7e6df04fd/restore-options \
  -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(DeviceType4snapshotsList)required

items[].idstringrequired

UID of the snapshot. Filter

Example: "b7107a30-260a-41c1-a47f-e50770c414c9"

items[].typestringrequired

type

Example: "string"

items[].adminAllocationSettingsobject or null(DeviceType4userAllocationSettingsSingle)

items[].baseIdinteger or null(int64)

snapshot Tdvv Size

items[].commentstring or null

Comments

items[].commonResourceAttributesobject or null(commonResourceAttributes)

items[].compressionPolicystring or null

compression policy

items[].conversionTypestring or null

Conversion Type of Volume

Enum"CONVERSIONTYPE_THIN""CONVERSIONTYPE_DDS""CONVERSIONTYPE_V1"

items[].copyOfIdinteger or null(int64)

Copy of ID

items[].creationTimeobject or null

Creation Time Sort

items[].customerIdstring or null

customerId

Example: "string"

items[].dataReductionstring or null

Data Reduction type

items[].dedupstring or null

items[].devTypestring or null

Device Type

items[].displaynamestring or null

Display name of the volume

items[].domainstring or null

Domain of the volume

items[].fullyProvisionedboolean or null

items[].generationinteger or null

generation

Example: 0

items[].headsPerCylinderinteger or null

Heads per Cylinder

items[].healthStateinteger or null(int64)

Health status of the Volume.

items[].hiddenboolean or null

Flag to know if the Volume is hidden or not

items[].initiatorsArray of objects or null

Initiator details

items[].namestring or null

A user friendly name to identify the storage system volume (resourceName).

Example: "Finance"

items[].parentIdinteger or null(int64)

Parent Id

items[].physParentIdinteger or null(int64)

physical Parent Id

items[].physicalCopyboolean or null

items[].policyobject or null(DeviceType4policy)

items[].provTypestring or null

Provisioning type

items[].raidstring or null

Raid

items[].rcopyStatusstring or null

RemoteCopy Status

items[].readOnlyboolean or null

items[].roChildIdinteger or null(int64)

RO child id

items[].rwChildIdinteger or null(int64)

items[].rwareAlertboolean or null

Indicates whether this snapshot acts as an alert snapshot for the base volume. Alert snapshot is generated when the OS detects a possible ransomware attack on the base volume (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and above).

items[].sectorsPerTrackinteger or null

Sector per Track

items[].sharedParentIdinteger or null(int64)

Shared Parent Id

items[].snapshotCapacityobject or null(DeviceType4SnapshotCapacity)

items[].snapshotIdinteger or null(int64)

Numeric ID of the resource

items[].snapshotTypestring or null

items[].startedboolean or null

items[].stateobject or null(DeviceType4State)

items[].systemIdstring or null

SystemUid/serialNumber of the array.

Example: "7CE751P312"

items[].thinProvisionedboolean or null

Thin provisioning details

items[].userAllocLimitinteger or null(int64)

User alloc limit

items[].userAllocWarninginteger or null(int64)

User alloc space limit warning

items[].userAllocationSettingsobject or null(DeviceType4userAllocationSettingsSingle)

items[].userCpgIdinteger or null(int64)

User CPG Id

items[].userCpgNamestring or null

User CPG Name

items[].vlunSectorSizeinteger or null

VLUN sector size

items[].wwnstring or null

Volume wwn.

Example: "60002AC0000000000000006B0001FFEB"

totalinteger

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

Response

application/json

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

Restore a child snapshot identified by {childSnapshotId} to a read-write parent snapshot identified by {parentSnapshotId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}

Request

Restore a child snapshot identified by {childSnapshotId} to a read-write parent snapshot identified by {parentSnapshotId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}

Security

bearer

Path

systemIdstringrequired

systemId of the storage system

Example: 7CE751P312

parentSnapshotIdstringrequired

UID of the read-write parent snapshot

Example: b7c4e6593f51d0b98f0e40d7e6df04fd

childSnapshotIdstringrequired

UID of the child snapshot to be restored

Example: c7c4e6593f51d0b98f0e40d7e6df04fd

Bodyapplication/json

prioritystring or null(DeviceType4Priority)

Enum"PRIORITYTYPE_HIGH""PRIORITYTYPE_MED""PRIORITYTYPE_LOW"

targetstring or null

Target read-write parent snapshot name to which the child snapshot need to be promoted.

Example: "snapshot-rw"

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/devtype4-storage-systems/7CE751P312/snapshots/b7c4e6593f51d0b98f0e40d7e6df04fd/snapshots/c7c4e6593f51d0b98f0e40d7e6df04fd/restore \
  -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"
}

HPE Greenlake For Block Storage REST APIs. (1.0.0)

host-initiator-groups

host-initiators

host-paths

host-sets

hosts

storage-pools

storage-systems

volume-sets

volumes

snapshots

Get the details of all read-write parent snapshots and base volume to which the child snapshot identified by {childSnapshotId} can be restored on HPE Alletra Storage MP B10000 system identified by {systemId}.

Request

Responses

Was this helpful?

Restore a child snapshot identified by {childSnapshotId} to a read-write parent snapshot identified by {parentSnapshotId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}

Request

Responses

Was this helpful?