Skip to content
/storage-pools

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

Get all storage-pools details by HPE Alletra Storage MP B10000

Request

Get all storage-pools details by 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

oData query to filter pools by Key.

Example: filter=name eq CPG_1
sortstring

oData query to sort pools 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/storage-pools \
  -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(DeviceType4PoolList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
items[].​typestringrequired

type

Example: "string"
items[].​alertobject or null(DeviceType4cpgAlert)
items[].​allocationSettingsobject or null(DeviceType4allocation)
items[].​associatedLinksArray of objects or null(DeviceType4poolsDeviceType4AssociatedLinks)
items[].​baseSizeMiBinteger

Number of LD MiB used in base virtual volumes.

Example: 67584
items[].​baseSizePrivateMiBnumber(Uint64)

Number of LD MiB private to individual base virtual volumes, not shared by deduplication

Example: 1215872
items[].​baseSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB used in base virtual volumes

Example: 90111
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​compactRationumber or null(float64)

Ratio between the virtual sizes of all volumes in the CPG and the amount of disk space they are currently using. Updated in Cloud Data Store at most once per 30 minutes.

Example: 5.722643930878938
items[].​compressRationumber(float64)

Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.

Example: 4.233684210526316
items[].​compressSavingsinteger or null(int64)

The space savings in MiB by compressing data

Example: 1
items[].​customerIdstring or null

customerId

Example: "string"
items[].​dataReduceRationumber(float64)

Ratio between the amount written to all volumes in the CPG and the amount of disk space used after compression and deduplication

Example: 2.25
items[].​dedupCapableboolean

Indicates whether the CPG supports dedup

Example: true
items[].​dedupRationumber(float64)

Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated

Example: 2.2464644143676713
items[].​dedupSavingsinteger or null(int64)

Savings from dedup in MiB

Example: 1
items[].​dedupVersionobject or null

Version of Dedup that is being used by volumes in the CPG

items[].​displaynamestring or null

Name to be used for display purposes

Example: "CPG Vega_7_test"
items[].​domainstring

Name of the domain that the CPG belongs to. Filter, Sort

Example: "testdomain"
items[].​freeForAllocationMiBnumber(Uint64)

Estimated free space for volume allocation (MiB)

Example: 4141056
items[].​freeSizeMiBnumber(Uint64)

Number of LD MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes. Filter, Sort

Example: 44672
items[].​freeSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.

Example: 16896
items[].​generationinteger or null

generation Filter, Sort

Example: 0
items[].​hostWrtinteger or null(int64)

Host writes in MiB

Example: 1
items[].​namestring<= 255 characters

Name of the resource. Filter, Sort

Example: "Vega_7_test"
items[].​nonReducibleDatainteger or null(int64)

Amount of data that could not be reduced

Example: 2
items[].​numberOfSnapRcnumber or null(Uint32)

Number of VVs used for Remote copy snapshot CPG usage

Example: 5
items[].​numberOfTdVvnumber(Uint32)

Number of TDVVs using the CPG

Example: 14
items[].​numberOfTpVvnumber(Uint32)

Number of TPVVs using the CPG

Example: 1062
items[].​numberOfUserRcnumber(Uint32)

Number of VVs used for Remote copy user CPG usage

Example: 5
items[].​overProvRationumber(float64)

Ratio between the virtual sizes of all volumes and the amount of used and free disk spaces. Updated in Cloud Data Store at most once per 30 minutes.

Example: 0.58
items[].​reduceSavingsinteger or null(int64)

Savings from data reduction in MiB and this is the combination of compression and dedup savings

Example: 2
items[].​reducibleReduceSavingsinteger or null(int64)

Data reduction savings in MiB using the reducible data. This savings is the combination of compression and dedup savings.

Example: 2
items[].​reducibleReduceSavingsRationumber or null(float64)

Data reduction savings using the reducible data. This savings is the combination of compression and dedup savings.

Example: 0.08
items[].​resourceUristring

resourceUri for detailed storage-pool object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178"
items[].​saGrowobject or null(DeviceType4cpgGrow)
items[].​sdGrowobject or null(DeviceType4cpgGrow)
items[].​sharedSizeMiBnumber(Uint64)

Number of LD MiB shared between volumes via deduplication

Example: 512
items[].​snapSizePrivateMiBnumber(Uint64)

Number of LD MiB private to individual snapshot virtual volumes, not shared by deduplication. Updated in Cloud Data Store at most once per 30 minutes.

Example: 526848
items[].​snapSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB used in snapshot virtual volumes. Updated in Cloud Data Store at most once per 30 minutes.

Example: 56831
items[].​snapSpaceAdminobject or null(DeviceType4snapSpace)
items[].​snapSpaceDataobject or null(DeviceType4snapSpace)
items[].​stateobject or null(DeviceType4CpgState)
items[].​storagePoolIdnumber(int64)

Numeric ID of the resource. Filter, Sort

Example: 4
items[].​systemIdstring

SystemID of the array. Filter, Sort

Example: "7CE809P009"
items[].​thinSavingsinteger or null(int64)

The space savings from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.

Example: 1
items[].​thinSavingsRationumber or null(float64)

The space savings ratio from a fully allocated virtual volume (FPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.

Example: 0.08
items[].​totalReservedMiBnumber(Uint64)

Total amount of space reserved by CPG (MiB)

Example: 1806336
items[].​totalSavingsinteger or null(int64)

Total space savings including thin, compression, dedup, clone, zero packing, and snaps, in MiB

Example: 2
items[].​totalSavingsRationumber or null(float64)

Total space savings ratio including thin, compression, dedup, clone, zero packing, and snaps

Example: 0.08
items[].​totalSizeMiBinteger

Total logical capacity in the user/snapshot space (MiB).

Example: 122880
items[].​totalSizeRawMiBnumber(Uint64)

Total physical (raw) MiB in the user/snapshot space

Example: 163839
items[].​userSpaceobject or null(DeviceType4snapSpace)
items[].​volumesCountinteger or null

Number of volumes in the CPG.

Example: 5
items[].​warnPercentnumber(Uint32)

Allocation warning percentage

Example: 5
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 storage-pool identified by {id}

Request

Get details of HPE Alletra Storage MP B10000 storage-pool identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

Identifier of pool. A 32 digit number.

Example: 147c439db3ecb34d1ccccc932d14fd60
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/block-storage/v1alpha1/devtype4-storage-systems/7CE751P312/storage-pools/147c439db3ecb34d1ccccc932d14fd60 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
typestringrequired

type

Example: "string"
alertobject or null(DeviceType4cpgAlert)
allocationSettingsobject or null(DeviceType4allocation)
associatedLinksArray of objects or null(DeviceType4poolsDeviceType4AssociatedLinks)
baseSizeMiBinteger

Number of LD MiB used in base virtual volumes

Example: 67584
baseSizePrivateMiBnumber(Uint64)

Number of LD MiB private to individual base virtual volumes, not shared by deduplication

Example: 1215872
baseSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB used in base virtual volumes

Example: 90111
commonResourceAttributesobject or null(commonResourceAttributes)
compactRationumber or null(float64)

Ratio between the virtual sizes of all volumes in the CPG and the amount of disk space they are currently using. Updated in Cloud Data Store at most once per 30 minutes.

Example: 5.722643930878938
compressRationumber(float64)

Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.

Example: 4.233684210526316
compressSavingsinteger or null(int64)

The space savings in MiB by compressing data

Example: 1
customerIdstring or null

customerId

Example: "string"
dataReduceRationumber(float64)

Ratio between the amount written to all volumes in the CPG and the amount of disk space used after compression and deduplication

Example: 2.25
dedupCapableboolean

Indicates whether the CPG supports dedup

Example: true
dedupRationumber(float64)

Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.

Example: 2.2464644143676713
dedupSavingsinteger or null(int64)

Savings from dedup in MiB

Example: 1
dedupVersionobject or null

Version of Dedup that is being used by volumes in the CPG

displaynamestring or null

Name to be used for display purposes

Example: "CPG Vega_7_test"
domainstring

Name of the domain that the CPG belongs to

Example: "testdomain"
freeForAllocationMiBnumber(Uint64)

Estimated free space for volume allocation (MiB)

Example: 4141056
freeSizeMiBnumber(Uint64)

Number of LD MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.

Example: 44672
freeSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.

Example: 16896
generationinteger or null

generation

Example: 0
hostWrtinteger or null(int64)

Host writes in MiB

Example: 1
namestring<= 255 characters

Name of the resource

Example: "Vega_7_test"
nonReducibleDatainteger or null(int64)

Amount of data that could not be reduced

Example: 2
numberOfSnapRcnumber or null(Uint32)

Number of VVs used for Remote copy snapshot CPG usage

Example: 5
numberOfTdVvnumber(Uint32)

Number of TDVVs using the CPG

Example: 14
numberOfTpVvnumber(Uint32)

Number of TPVVs using the CPG

Example: 1062
numberOfUserRcnumber(Uint32)

Number of VVs used for Remote copy user CPG usage

Example: 5
overProvRationumber(float64)

Ratio between the virtual sizes of all volumes and the amount of used and free disk spaces. Updated in Cloud Data Store at most once per 30 minutes.

Example: 0.58
reduceSavingsinteger or null(int64)

Savings from data reduction in MiB and this is the combination of compression and dedup savings

Example: 2
reducibleReduceSavingsinteger or null(int64)

Data reduction savings in MiB using the reducible data. This savings is the combination of compression and dedup savings.

Example: 2
reducibleReduceSavingsRationumber or null(float64)

Data reduction savings ratio using the reducible data. This savings ratio is the combination of compression and dedup savings.

Example: 0.08
resourceUristring

resourceUri for detailed storage-pool object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178"
saGrowobject or null(DeviceType4cpgGrow)
sdGrowobject or null(DeviceType4cpgGrow)
sharedSizeMiBnumber(Uint64)

Number of LD MiB shared between volumes via deduplication

Example: 512
snapSizePrivateMiBnumber(Uint64)

Number of LD MiB private to individual snapshot virtual volumes, not shared by deduplication. Updated in Cloud Data Store at most once per 30 minutes.

Example: 526848
snapSizeRawMiBnumber(Uint64)

Number of physical (raw) MiB used in snapshot virtual volumes. Updated in Cloud Data Store at most once per 30 minutes.

Example: 56831
snapSpaceAdminobject or null(DeviceType4snapSpace)
snapSpaceDataobject or null(DeviceType4snapSpace)
stateobject or null(DeviceType4State)
storagePoolIdnumber(int64)

Numeric ID of the resource

Example: 4
systemIdstring

SystemID of the array

Example: "7CE809P009"
thinSavingsinteger or null(int64)

The space savings from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.

Example: 1
thinSavingsRationumber or null(float64)

The space savings ratio from a fully allocated virtual volume (FPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.

Example: 0.08
totalReservedMiBnumber(Uint64)

Total amount of space reserved by CPG (MiB)

Example: 1806336
totalSavingsinteger or null(int64)

Total space savings including thin, compression, dedup, clone, zero packing, and snaps, in MiB

Example: 2
totalSavingsRationumber or null(float64)

Total space savings ratio including thin, compression, dedup, clone, zero packing, and snaps

Example: 0.08
totalSizeMiBinteger

Total logical capacity in the user/snapshot space (MiB)

Example: 122880
totalSizeRawMiBnumber(Uint64)

Total physical (raw) MiB in the user/snapshot space

Example: 163839
userSpaceobject or null(DeviceType4snapSpace)
volumesCountinteger or null

Number of volumes in the CPG.

Example: 5
warnPercentnumber(Uint32)

Allocation warning percentage

Example: 5
Response
application/json
{
  "alert": {
    "fail": "--",
    "limit": "--",
    "warn": "--",
    "warnPercent": 2
  },
  "allocationSettings": {
    "chunkletPosPref": "Position1",
    "deviceSpeed": { … },
    "deviceType": "DEVICE_TYPE_SSD",
    "diskFilter": "test",
    "ha": { … },
    "raidType": "RAID_SIX",
    "requestedHa": { … },
    "setSize": "6 data, 2 parity",
    "stepSize": -1
  },
  "associatedLinks": [
    { … },
    { … }
  ],
  "baseSizeMiB": 67584,
  "baseSizePrivateMiB": 1215872,
  "baseSizeRawMiB": 90111,
  "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."
  },
  "compactRatio": 5.722643930878938,
  "compressRatio": 4.233684210526316,
  "compressSavings": 1,
  "customerId": "string",
  "dataReduceRatio": 2.25,
  "dedupCapable": true,
  "dedupRatio": 2.2464644143676713,
  "dedupSavings": 1,
  "dedupVersion": {
    "default": "string",
    "key": "string"
  },
  "displayname": "CPG Vega_7_test",
  "domain": "testdomain",
  "freeForAllocationMiB": 4141056,
  "freeSizeMiB": 44672,
  "freeSizeRawMiB": 16896,
  "generation": 0,
  "hostWrt": 1,
  "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  "name": "Vega_7_test",
  "nonReducibleData": 2,
  "numberOfSnapRc": 5,
  "numberOfTdVv": 14,
  "numberOfTpVv": 1062,
  "numberOfUserRc": 5,
  "overProvRatio": 0.58,
  "reduceSavings": 2,
  "reducibleReduceSavings": 2,
  "reducibleReduceSavingsRatio": 0.08,
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  "saGrow": {
    "args": "-p -devtype SSD",
    "limitMiB": 10,
    "sizeMiB": 12,
    "warnMiB": 10
  },
  "sdGrow": {
    "args": "-p -devtype SSD",
    "limitMiB": 10,
    "sizeMiB": 12,
    "warnMiB": 10
  },
  "sharedSizeMiB": 512,
  "snapSizePrivateMiB": 526848,
  "snapSizeRawMiB": 56831,
  "snapSpaceAdmin": {
    "ldCount": 4,
    "totalMiB": 83968,
    "totalRawMiB": 251904,
    "usedMiB": 75008,
    "usedRawMiB": 225024
  },
  "snapSpaceData": {
    "ldCount": 4,
    "totalMiB": 83968,
    "totalRawMiB": 251904,
    "usedMiB": 75008,
    "usedRawMiB": 225024
  },
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "storagePoolId": 4,
  "systemId": "7CE809P009",
  "thinSavings": 1,
  "thinSavingsRatio": 0.08,
  "totalReservedMiB": 1806336,
  "totalSavings": 2,
  "totalSavingsRatio": 0.08,
  "totalSizeMiB": 122880,
  "totalSizeRawMiB": 163839,
  "type": "string",
  "userSpace": {
    "ldCount": 4,
    "totalMiB": 83968,
    "totalRawMiB": 251904,
    "usedMiB": 75008,
    "usedRawMiB": 225024
  },
  "volumesCount": 5,
  "warnPercent": 5
}

Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP B10000

Request

Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP B10000

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

Identifier of pool. A 32 digit number.

Example: 147c439db3ecb34d1ccccc932d14fd60
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/storage-pools/147c439db3ecb34d1ccccc932d14fd60/volumes \
  -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(DeviceType4VolumeDetailsList)required
items[].​idstringrequired

UUID string uniquely identifying the storage system object. Filter

items[].​typestringrequired

type

Example: "string"
items[].​adminAllocationSettingsobject or null(DeviceType4userAllocationSettings)
items[].​associatedLinksArray of objects or null

Associated Links

Example: [{"resourceUri":"v1/storage-systems/{systemUid}/contollers","type":"controllers"},{"resourceUri":"v1/storage-systems/{systemUid}/shelves","type":"shelves"},{"resourceUri":"v1/storage-systems/{systemUid}/disks","type":"disks"},{"resourceUri":"v1/storage-systems/{systemUid}/storage-ports","type":"storage-ports"},{"resourceUri":"v1/storage-systems/{systemUid}/storage-devices-settings","type":"storage-devices-settings"},{"resourceUri":"v1/storage-systems/{systemUid}/storage-pools","type":"storage-pools"},{"resourceUri":"v1/storage-systems/{systemUid}/volume-sets","type":"volume-sets"},{"resourceUri":"v1/storage-systems/{systemUid}/host-groups","type":"host-groups"}]
items[].​baseIdinteger or null(int64)

snapshot Tdvv Size

items[].​bulkvvboolean or null

Volume is bulk volume or not

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[].​copyOfShortNamestring or null

Short name of volume parent, if a copy

Example: "VegaCopyOfShortNames~66"
items[].​creationTimeobject or null

Creation Time. Sort

items[].​customerIdstring or null

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​dataReductionstring or null

Data Reduction type. Possible values:

  • DATA_REDUCTION_ON
  • DATA_REDUCTION_OFF
  • DATA_REDUCTION_DISABLED
items[].​dedupstring or null

Field to indicate Dedup status

items[].​devTypestring or null

Device Type Filter

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 Filter, Sort

Example: 0
items[].​headsPerCylinderinteger or null

Heads per Cylinder

items[].​healthStateinteger or null(int64)

Health status of the Volume. Filter, Sort

items[].​hiddenboolean or null

Flag to know if the Volume is hidden or not

items[].​namestring or null

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

Example: "Finance"
items[].​nguidstring or null

Namespace Globally Unique Identifier. This data is available only for NVMe enabled storage system. Filter

Example: "60002AC0000800660002AC130007EEFD"
items[].​parentIdinteger or null(int64)

Parent Id Filter

items[].​pevvboolean or null

Volume is pe volume or not

items[].​physParentIdinteger or null(int64)

physical Parent Id

items[].​physicalCopyboolean or null
items[].​policyobject or null(DeviceType4policy)
items[].​provTypestring or null

Description

items[].​raidstring or null

Raid

items[].​rcopyStatusstring or null

RemoteCopy Status

items[].​readOnlyboolean or null
items[].​resourceUristring or null

resourceUri for detailed volume object

Example: "/v1/storage-systems/primea/2FF70002AC018D94/volumes/{uid}"
items[].​sectorsPerTrackinteger or null

Sector per Track

items[].​sharedParentIdinteger or null(int64)

Shared Parent Id

items[].​shortNamestring or null

Short name of the storage system volume

Example: "VegaVolumesShortName~67245"
items[].​snapShotTierstring or null

Snapshot Tier

items[].​startedboolean or null
items[].​stateobject or null(DeviceType4State)
items[].​storageTierstring or null

Storage Tier

items[].​systemIdstring or null

SystemUid/serialNumber of the array.

Example: "7CE751P312"
items[].​thinProvisionedboolean or null

Description

items[].​userAllocLimitinteger or null(int64)

User alloc limit

items[].​userAllocWarninginteger or null(int64)

User alloc space limit warning

items[].​userAllocationSettingsobject or null(DeviceType4userAllocationSettings)
items[].​userCpgIdinteger or null(int64)

User CPG Id Filter

items[].​userCpgNamestring or null

User CPG Name Filter

items[].​usrCpgShortNamestring or null

Short name of volume user CPG

Example: "VegaUserCpgShortName~97"
items[].​vlunSectorSizeinteger or null

VLUN sector size

items[].​volumeCapacityobject or null(DeviceType4VolumeCapacity)
items[].​volumeIdinteger or null(int64)

Numeric ID of the resource

items[].​volumePerformanceobject or null(DeviceType4volumePerformanceDetails)
items[].​volumeTypestring or null

VV Type

Example: "VVTYPE_BASE"
items[].​wwnstring or null

Volume wwn. Filter

Example: "60002AC0000000000000006B0001FFEB"
totalinteger

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

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

Get all storage pools for a device {systemId}

Request

Get all storage pools for a device {systemId}

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

oData query to filter pools by Key.

Example: filter=name eq CPG_1
sortstring

oData query to sort pools 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/storage-systems/7CE751P312/storage-pools \
  -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(FleetPoolList)required
items[].​idstringrequired

Unique Identifier of the resource

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
items[].​typestringrequired

The type of resource.

items[].​associatedLinksArray of objects or null(fleetAssociatedLinks)
items[].​capacityUsedinteger

Capacity Used

Example: 56446
items[].​customerIdstring

The customer application identifier

items[].​domainstring

Domain of the storage pool.Filter

Example: "domain"
items[].​generationinteger(int64)

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​namestring<= 255 characters

Name of the resource

Example: "Vega_7_test"
items[].​resourceUristring

resourceUri for detailed storage-pool object

Example: "/block-storage/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178"
items[].​systemIdstring

SystemID of the array

Example: "7CE809P009"
totalinteger

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

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

Get details of storage pools identified by {id}

Request

Get details of storage pools identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

Identifier of pool. A 32 digit number.

Example: 147c439db3ecb34d1ccccc932d14fd60
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/block-storage/v1alpha1/storage-systems/7CE751P312/storage-pools/147c439db3ecb34d1ccccc932d14fd60 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
typestringrequired

The type of resource.

associatedLinksArray of objects or null(fleetAssociatedLinks)
capacityUsedinteger

Capacity Used

Example: 56446
customerIdstring

The customer application identifier

domainstring

Domain of the storage pool.

Example: "domain"
generationinteger(int64)

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

namestring<= 255 characters

Name of the resource

Example: "Vega_7_test"
resourceUristring

resourceUri for detailed storage-pool object

Example: "/block-storage/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178"
systemIdstring

SystemID of the array

Example: "7CE809P009"
Response
application/json
{
  "associatedLinks": [
    { … },
    { … }
  ],
  "capacityUsed": 56446,
  "customerId": "string",
  "domain": "domain",
  "generation": 0,
  "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  "name": "Vega_7_test",
  "resourceUri": "/block-storage/v1alpha1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  "systemId": "7CE809P009",
  "type": "string"
}

Get all volumes for storage-pool identified by {id}

Request

Get all volumes for storage-pool identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

Identifier of pool. A 32 digit number.

Example: 147c439db3ecb34d1ccccc932d14fd60
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/block-storage/v1alpha1/storage-systems/7CE751P312/storage-pools/147c439db3ecb34d1ccccc932d14fd60/volumes \
  -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(fleetVolumeDetailsList)required
items[].​idstringrequired

UUID string uniquely identifying the storage system object. Filter

Example: "e66ed5ce8d35961481a48b4f78bb06b4"
items[].​typestringrequired

type

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

Associated Links

Example: [{"resourceUri":"/block-storage/v1alpha1/storage-systems/storage-pools/{uid}","type":"storage-pools"},{"resourceUri":"/block-storage/v1alpha1/storage-systems/volume-sets/{uid}","type":"volume-sets"},{"resourceUri":"/block-storage/v1alpha1/storage-systems/{uid}","type":"systems"}]
items[].​commonResourceAttributesobject or null(commonResourceAttributesfleet)
items[].​customerIdstring or null

customerId

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

generation

Example: 0
items[].​healthStatestring or null

Health State of volume. Filter, Sort

Example: "NORMAL"
items[].​hostWrittenCapacityMiBnumber or null(float64)

Host written data size in MiB. Filter, Sort

Example: 0
items[].​intrinsicResourcestring or null

type of volume

Example: "volume"
items[].​isInternalboolean or null

boolean value which specifies if it is a systemVolume or not

Example: false
items[].​namestring or null

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

Example: "Finance"
items[].​productFamilystring or null

Product Family

Example: "deviceType1"
items[].​provisionedSizeMiBnumber or null(float64)

Provisioned Size in MiB

Example: 2048
items[].​resourceUristring or null

resourceUri for detailed volume object

Example: "/block-storage/v1alpha1/storage-systems/volumes"
items[].​sizeMiBnumber or null(float64)

Size in MiB Filter, Sort

Example: 2048
items[].​spaceWarningnumber or null(float64)(spaceWarning)
items[].​subTypestring or null

subType of the volume

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

SystemUid/Serial Number of the array. Filter, Sort

Example: "7CE751P312"
items[].​thinSavingsstring or null

Thin savings

Example: "1:1"
items[].​usedCapacityPercentnumber or null

Used capacity percentage of volume.

Example: 1.2345
items[].​usedSizeMiBnumber or null(float64)

Size in MiB

items[].​volumeSetIdstring or null

SystemUid/serialNumber of the volumeSet.

Example: "7CE751P312"
items[].​volumeTypestring or null

VV Type

Example: "VVTYPE_BASE"
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": [
    { … }
  ]
}

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