Skip to content
/volume-sets

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

Get all applicationset details for HPE Alletra Storage MP B10000

Request

Get all applicationset details for HPE Alletra Storage MP B10000

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

Lucene query to filter application-sets by Key.

Example: filter=uid eq 2a0df0fe6f7dc7bb16000000000000000000004817
sortstring

Lucene query to sort application-sets 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/block-storage/v1alpha1/devtype4-storage-systems/7CE751P312/applicationsets \
  -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(DeviceType4ApplicationSets)required
items[].​idstringrequired

uid of the applicationset Filter

Example: "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0"
items[].​typestringrequired

type

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

Appset BusinessUnit

Example: "cssl"
items[].​appSetCommentsstring or null

Application set comments

Example: "app set comments"
items[].​appSetExcludeAiQoSstring or null

Exclusion from AI QoS

Example: "no"
items[].​appSetIdinteger or null

ID

Example: 5
items[].​appSetImportancestring or null

Importance Level

Example: "MEDIUM"
items[].​appSetNamestring or null<= 255 characters

Application set name. Filter

Example: "KA_VEGA_APPSET1_186"
items[].​appSetTypestring or null

Name of the resource. Filter

Example: "Oracle Database"
items[].​appSetTypeEnumstring or null

Enum value of type of the application set

Example: "ORACLE_DATA"
items[].​associatedLinksArray of objects or null

Associated Links Details

Example: [{"resourceUri":"/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC01F0FF","type":"systems"},{"resourceUri":"/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC01F0FF/volumes","type":"volumes"}]
items[].​commentstring or null

Comments if any

Example: "Comments"
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​displayNamestring or null<= 255 characters

Display Name

Example: "Application Set KA_VEGA_APPSET1_186 "
items[].​domainstring or null<= 255 characters

Domain name. Filter

Example: "Domain"
items[].​drStatestring or null

Specifies replication disaster recovery state of a protected volume set. Possible values: Normal, Failover, Recover, Unknown The disaster recovery state is Unknown for any intermediate state.

Example: "Normal"
items[].​exportStatusstring or null

Export status

Example: "PARTIALLY_EXPORTED"
items[].​generationinteger or null

generation. Filter, Sort

Example: 0
items[].​initiatorsArray of objects or null

Initiator details

items[].​isPrimaryboolean or null

States if the Application set is Primary or not

Example: true
items[].​kvPairsPresentboolean

Represents KV pairs present or not

Example: true
items[].​membersArray of strings or null or null

Volume Names. Filter, Sort

Example: ["vol1","vol2"]
items[].​namestring or null<= 255 characters

Name of the resource. Filter, Sort

Example: "volset_name"
items[].​nonZeroRtoConfigstring or null

Non-Zero RTO configuration. Supported config is Active-Sync

Example: "ActiveSync"
items[].​ransomwareboolean or null

Indicates Whether ransomware detection has been enabled on this volume set (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and later).

items[].​remoteRecoveryPointobject or null(DeviceType4RecoveryPoint)
items[].​replicationPartnerArray of objects or null or null

Shows the Replication Partner Systems and Replication Partners

Example: [{"partnerSystem":"cs2-C630-2939-141","replicationPartner":"cs2-C630-2939_s1511"},{"partnerSystem":"s2940_208","replicationPartner":"s2940_1"}]
items[].​replicationStatestring or null

Shows the replication state of the application set. This is not applicable in case of a 3DC/SLD configuration.

Example: "Started"
items[].​replicationTrafficstring or null

Shows the direction of flow of data. This is not applicable in case of a 3DC/SLD configuration.

Example: "Sending"
items[].​replicationTypestring or null

Mode of replication. Can be sync or periodic. This is not applicable in case of a 3DC/SLD configuration.

Example: "periodic"
items[].​rolestring or null

Specifies remote copy role for a protected volume set. Possible values: Primary, Secondary, Primary-Rev, Secondary-Rev, Unknown The role status is Unknown for any intermediate remote copy role of a protected volume set.

Example: "Primary"
items[].​shortNamestring or null

Short name of the application set

Example: "VegaApplications~886"
items[].​sizeMiBnumber or null(float64)

Size in MB of appset

Example: 153600
items[].​snapSetParentIdinteger or null(int64)

ParentId of the snapSet. Filter

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

Parent name of the snapSet. Filter

Example: "HPE"
items[].​systemIdstring or null

SystemUid/serialNumber of the array. Filter, Sort

Example: "7CE751P312"
items[].​vvSetTypestring or null<= 255 characters

Type of the volume-set. Filter

Example: "VVSET"
items[].​zeroRtoConfigstring or null

Zero RTO configuration. Supported config is Active Peer Persistence. Classic Peer Persistence is not supported for HPE Alletra Storage MP B10000.

Example: "PP"
totalinteger

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

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

Create Application Set for an HPE Alletra Storage MP B10000 storage system

Request

Create Application Set for an HPE Alletra Storage MP B10000 storage system

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
appSetNamestringrequired

App set name

Example: "Appset_134"
appSetTypestring or null(DeviceType4VolumeSetApplicationType)required
Enum"ORACLE_DATA""ORACLE_LOG""MICROSOFT_EXCHANGE"
appSetBusinessUnitstring or null

App set business unit

Example: "HPE"
appSetCommentsstring or null

App set comments

Example: "Edit appset"
createAppSetQosConfigInputobject or null(DeviceType4CreateAppSetQosConfigInput)
customAppTypestring or null

App set name for Custom workloads when appSetType=CUSTOM

Example: "CustomWorkload_123"
membersArray of strings or null or null

volumes list

Example: ["vol1","vol2"]
ransomwareboolean or null

This attribute enables/disables ransomware detection on the volume set. Both the existing volumes in the volume set as well as the volumes which get added in future in to this volume set will have this ransomware setting. By Default, it is set to false. This applies to the HPE Alletra Storage MP B10000 systems running OS version 10.5.0 and later.

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/devtype4-storage-systems/7CE751P312/applicationsets \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appSetName": "Appset_134",
    "appSetType": "ORACLE_LOG"
  }'

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 applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}

Request

Export applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
appsetIdstringrequired

UID of the applicationset

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

HostGroups

hostGroupDataMapArray of objects or null

Host Group IDs and the corresponding attributes for each host group ID. NVMe transport type for each host Group ID is defined in this map and it is applicable if all the hosts of this host group are associated with the NVMe protocol.

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/v1alpha1/devtype4-storage-systems/7CE751P312/applicationsets/e9d353bf98fc1a6bdb90b824e3ca14b5/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"
}

volumes

The volumes API allows the management of volumes

Operations

snapshots

Operations