GetVolumeAccessGroupEfficiency

You can use the GetVolumeAccessGroupEfficiency method to get efficiency information about a volume access group. Only the volume access group you provide as the parameter in this API method is used to compute the capacity.

Parameter

This method has the following input parameter:

Name Description Type Default value Required
volumeAccessGroupID Specifies the volume access group for which capacity is computed. integer None Yes

Return value

This method has the following return value:

Name Description Type
compression The amount of space saved by data compression for all volumes in the volume access group. Stated as a ratio where a value of 1 means data has been stored with no compression. float
deduplication The amount of space saved by not duplicating data for all volumes in the volume access group. Stated as a ratio. float
thinProvisioning The ratio of space used to the amount of space allocated for storing data. Stated as a ratio. float
timestamp The last time efficiency data was collected after garbage collection. ISO 8601 data string
missingVolumes The volumes that could not be queried for efficiency data. Missing volumes can be caused by a recent garbage collection, temporary network loss or restarted services since the garbage collection cycle. integer array

Request example

Requests for this method are similar to the following example:

{
   "method": "GetVolumeAccessGroupEfficiency",
   "params": {
      "volumeAccessGroupID": 1
   },
   "id": 1
}

Response example

This method returns a response similar to the following example:

{
   "id": 1,
   "result": {
       "compression": 2.006012925331075,
       "deduplication": 1,
       "missingVolumes": [],
       "thinProvisioning": 1.009861932938856,
       "timestamp": "2014-03-10T17:05:27Z"
   }
}