Loading...

REST API - GET Storage Pool Details

This operation returns the details for the given storage pool.

Request

Syntax

GET <webservice>/StoragePool/{storagePoolId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

storagepoolID

The storage pool ID for the storage pool. If the storage pool ID is not known, use the GET Storage Pool to retrieve it.

Response

Response Parameters

Parameter

Description

Element

totalFreeSpace

Total amount of free space in the storage pool.

storagePoolDetails

totalCapacity

Total capacity of the storage pool.

storagePoolDetails

status

Status of the storage pool.

storagePoolDetails

sizeOnDisk

The actual size of the data on disk.

storagePoolDetails

retention

The retention parameters established for the storage pool.

storagePoolDetails

reserved

Whether the storage pool is currently reserved.

storagePoolDetails

redundancyFactor

 

storagePoolDetails

numOfSpareMedia

For tape library storage pool - the total amount of spare media.

storagePoolDetails

numOfMedia"

For tape library storage pool - the total spare media.

storagePoolDetails

numOfCleaningMedia

For tape library storage pool - the total amount of cleaning  media.

storagePoolDetails

lastDayThroughput

The average throughput for the last 1 day.

storagePoolDetails

disperseFactor

 

storagePoolDetails

devicePath

 

storagePoolDetails

applicationSize

The size of application data.

storagePoolDetails

uniqueBlocksOfStore

Total number of unique blocks in the deduplication database( DDB).

dedupDBDetails

totalDataSize

Total data size in the DDB.

dedupDBDetails

totalAppSize”

The application of data in the DDB.

dedupDBDetails

storeNameAlias”

Alias of the DDB store.

dedupDBDetails

storeName

Name of the DDB store.

dedupDBDetails

storeId

The system generated ID for the DDB.

dedupDBDetails

storeFlags

 

dedupDBDetails

sizeOnMedia

The size of the DDB in the media.

dedupDBDetails

sealedTime”

The time at which the DDB was sealed. (If the DDB was sealed.)

dedupDBDetails

retentionDaysForCopy”

The retention days for the copies.

dedupDBDetails

retentionCyclesForCopy

The retention cycles for the copies.

dedupDBDetails

prunePending

 

dedupDBDetails

primaryRecordsPercentage

 

dedupDBDetails

numberOfJobs

 

dedupDBDetails

noOfPartitions”

The total number of partitions in the DDB.

dedupDBDetails

maxAvgQITime

 

dedupDBDetails

maxAllowedConnections

 

dedupDBDetails

freeSpaceOnLibrary

 

dedupDBDetails

fragmentedSpaceSize

 

dedupDBDetails

dedupeFlags

 

dedupDBDetails

deDupSavingSize”

 

dedupDBDetails

deDupSavingPercent=

 

dedupDBDetails

ddbVersion=

 

dedupDBDetails

creationtime=

DDB creation time.

dedupDBDetails

commcellId

 

dedupDBDetails

baselineSize

 

dedupDBDetails

baselineApplicationSize

 

dedupDBDetails

avgQITimeOfStore

 

dedupDBDetails

status

 

storagePoolNodeDetailsList

reserved4

 

storagePoolNodeDetailsList

reserved3

 

storagePoolNodeDetailsList

reserved2

 

storagePoolNodeDetailsList

reserved1

 

storagePoolNodeDetailsList

diskFreeSpace

 

storagePoolNodeDetailsList

diskCapacity

 

storagePoolNodeDetailsList

devicePathOnNode

 

storagePoolNodeDetailsList

ddbEnabled

 

storagePoolNodeDetailsList

configuredInStoragePool

 

storagePoolNodeDetailsList

mediaAgentName

 

mediaAgent

mediaAgentId

 

mediaAgent

_type_

 

mediaAgent

ddbStoreIdList val

 

mediaAgent

Note: The storagePoolNodeDetailsList is returned for Hyperscale and ScaleOut storage pools only.

Examples

Sample Request

GET <webservice>/StoragePool/2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetStoragePoolDetailsResp>
 <storagePoolDetails totalFreeSpace="387223513989" totalCapacity="429281981235" status="Online" sizeOnDisk="41933602816" retention="15 day(s), 2 cycle(s)" reserved4="" reserved3="" reserved2="0" reserved1="1" redundancyFactor="1" numOfSpareMedia="0" numOfMedia="0" numOfCleaningMedia="0" lastDayThroughput="" disperseFactor="3" devicePath="/ws/glus" applicationSize="41778435183">
  <dedupDBDetails uniqueBlocksOfStore="0" totalDataSize="0" totalAppSize="0" storeNameAlias="SIDB_GDSP_DiskLib_StoragePool_(384)_Primary" storeName="SIDB_GDSP_DiskLib_StoragePool_(384)_Primary (Feb 27 2017 8:42AM)" storeId="107" storeFlags="537919490" sizeOnMedia="0" sealedTime="0" retentionDaysForCopy="-1" retentionCyclesForCopy="-1" reserveField8="" reserveField7="" reserveField6="0" reserveField5="0" reserveField4="0" reserveField3="" reserveField2="0" reserveField1="0" prunePending="0" primaryRecordsPercentage="0" numberOfJobs="0" noOfPartitions="3" maxAvgQITime="2000" maxAllowedConnections="200" freeSpaceOnLibrary="369280" fragmentedSpaceSize="0" dedupeFlags="369885192" deDupSavingSize="0" deDupSavingPercent="" ddbVersion="-1" creationtime="1488184945" commcellId="2" baselineSize="0" baselineApplicationSize="0" avgQITimeOfStore="0"/>
   <storagePoolNodeDetailsList status="Online" reserved4="" reserved3="" reserved2="0" reserved1="1" diskFreeSpace="107287150592" diskCapacity="107321753600" devicePathOnNode="/ws/disk1" ddbEnabled="1" configuredInStoragePool="1">
    <mediaAgent mediaAgentName="poolupg1" mediaAgentId="18" _type_="11"/>
    <ddbStoreIdList val="107"/>
</storagePoolNodeDetailsList>
   <storagePoolNodeDetailsList status="Online" reserved4="" reserved3="" reserved2="0" reserved1="1" diskFreeSpace="107287150592" diskCapacity="107321753600" devicePathOnNode="/ws/disk2" ddbEnabled="1" configuredInStoragePool="1">
    <mediaAgent mediaAgentName="poolupg3" mediaAgentId="20" _type_="11"/>
    <ddbStoreIdList val="107"/>
  </storagePoolNodeDetailsList>
 </storagePoolDetails>
</EVGui_GetStoragePoolDetailsResp>

Last modified: 1/10/2018 7:55:19 PM