Skip to main content

Get Disk Storage Details​

Get details of a disk storage pool based on id

Path Parameters
  • storagePoolId int32 required

    Id of the disk storage pool whose details have to be fetched

Query Parameters
  • showInheritedAssociation boolean

    Show inherited security association

Responses

Success

Schema
  • id int32

    Id of the Disk Storage Pool

  • name string

    Name of the Disk Storage Pool

  • general object
  • capacity int32

    specifies the capacity of the storage pool

  • freeSpace int32

    specifies the available space on the storage pool

  • sizeOnDisk int32

    Size on disk refers to the actual amount of space being taken by the storage pool on the disk.

  • dedupeSavingsPercent int32

    specifies the savings that occurred due to deduplication. Only available for dedupe storage pools.

  • backupLocations object[]

    Gives backup location/mount path details for the storage pool.

  • id int32
  • name string
  • status string
  • encryption object

    Different ways in which data can be encrypted.

  • encrypt boolean
  • keyLength int32

    Different keylengths are present for different kinds of ciphers. Blowfish,Twofish,AES and Serpent all accept both 128 and 256. DES3 accepts only 192. GOST accepts only 256.

  • cipher string

    Possible values: [BlowFish, AES, DES3, GOST, Serpent, Twofish]

    The different types of encryption keys that can be used for encrypting the data. The values are case sensitive

  • keyProvider object
  • id int32
  • name string
  • security object

    A list of users or user groups each having a specific set of roles that determine the kind of operations they can perform on the entity.

  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • externalUserGroup object

    External User Group Entity

  • id int32

    User Group Id

  • name string

    External Group Name

  • providerId int32

    Provider id

  • providerName string

    Provider Name

  • isCreatorAssociation boolean
  • role object
  • id int32
  • name string
  • permissionList object[]
  • permissionId int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag to specify if this is included permission or excluded permission.

  • associatedPlanList object[]

    Provides the list of plans associated with the storage pool.

  • id int32
  • name string
GET /v4/storage/disk/:storagepoolid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
storagePoolId — path required
showInheritedAssociation — query
curl -L -X GET 'https://localhost/webconsole/api/V4/Storage/Disk/:storagePoolId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'