Skip to content
/volumes

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
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/block-storage/public/openapi/block-storage-latest/v1/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

Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000 systems.

Request

Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000 systems.

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
snapshotIdstringrequired

UID of the snapshots

Example: a7c4e6593f51d0b98f0e40d7e6df04fd
Bodyapplication/jsonrequired
destinationVolumestringrequired

Name of the destination volume.

Example: "destinationVol1"
autoLunboolean or null

Secify to use auto lun number.

Example: true
destinationCpgstring or null

Name of the User CPG

Example: "SSD_r6"
hostGroupIdstring or null

Unique identifier of host group.

Example: "fd3244ef7f1ab8bd16500c7a41bdf8f8"
luninteger or null(int64)

LUN of volume.

Example: 0
prioritystring or null

Priority of the task for clone of a snashot. Defualts to MEDIUM.

Enum"PRIORITYTYPE_HIGH""PRIORITYTYPE_MED""PRIORITYTYPE_LOW"
Example: "PRIORITYTYPE_MED"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/snapshots/a7c4e6593f51d0b98f0e40d7e6df04fd/clone \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destinationVolume": "destinationVol1"
  }'

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

Export vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Request

Export vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
snapshotIdstringrequired

UID of the snapshots

Example: a7c4e6593f51d0b98f0e40d7e6df04fd
Bodyapplication/jsonrequired
hostGroupIdsArray of strings or null or nullrequired

HostGroups

autoLunboolean or null

Auto Lun

Example: true
lunArray of objects or null

Custom LUN Id for multiple host groups

maxAutoLuninteger or null(int64)

Number of volumes.

Example: 1
noVcnboolean or null

No VCN

Example: true
overrideboolean or null

Override

Example: true
proximitystring

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Enum"PRIMARY""SECONDARY""ALL"
Example: "PRIMARY"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/snapshots/a7c4e6593f51d0b98f0e40d7e6df04fd/export \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostGroupIds": [
      "string"
    ]
  }'

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

Create snapshot of snapshot identified by {snapshotId} on a HPE Alletra storage MP system identified by {systemId}

Request

Create snapshot of snapshot identified by {snapshotId} on a HPE Alletra storage MP system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
snapshotIdstringrequired

UID of the snapshots

Example: a7c4e6593f51d0b98f0e40d7e6df04fd
Bodyapplication/jsonrequired
namePatternstring or null(DeviceType4NamePattern)required
Enum"PARENT_TIMESTAMP""PARENT_SEC_SINCE_EPOCH""CUSTOM"
commentstring or null

Comment if any

Example: ""
customNamestring or null

Name for snapshot. For the HPE Alletra Storage MP B10000 systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.

Example: "snap1"
expireSecsinteger or null

Expiration time in seconds

Example: 86400
readOnlyboolean or null

Read only or Read/Write

Example: false
retainSecsinteger or null(int64)

Reatain time in seconds

Example: 86400
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1/devtype4-storage-systems/7CE751P312/snapshots/a7c4e6593f51d0b98f0e40d7e6df04fd/snapshots \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "namePattern": "PARENT_TIMESTAMP"
  }'

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

snapshots

Operations