Getting information about the total efficiency of a storage system

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
Obtain information about the saving efficiency for consumption of capacity (total efficiency) achieved by using the functions for increasing the usage efficiency of a storage system such as the capacity saving function (dedupe and compression), the accelerated compression function, the creation of backup data by using snapshots, and the virtualization of capacity by using Dynamic Provisioning.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/total-efficiencies/instance

Request message

Object ID
Specify instance. If an object has only one instance, the value for instance is the fixed value that specifies the object ID.
Query parameters

None.

Body

None.

Response message

Body
{
  "isCalculated" : true,
  "totalRatio" : "8.46",
  "compressionRatio" : "1.18",
  "snapshotRatio" : "97.21",
  "provisioningRate" : "85",
  "calculationStartTime" : "2016-07-31T16:55:07Z",
  "calculationEndTime" : "2016-07-31T17:06:35Z",
  "dedupeAndCompression" : {
    "totalRatio" : "1.47",
    "compressionRatio" : "1.08",
    "dedupeRatio" : "1.35",
    "reclaimRatio" : "1.00"
  },
  "acceleratedCompression" : {
    "totalRatio" : "1.11",
    "compressionRatio" : "1.10",
    "reclaimRatio" : "1.00"
  }
}

Attribute

Type

Description

isCalculated

boolean

Calculation status of the total efficiency

This attribute indicates whether the total efficiency has been calculated.

  • true: The values have been calculated.
  • false: The values have not been calculated.

Information about the other attributes will only be obtained if the value for this attribute is true.

calculationStartTime

ISO8601string

The date and time when the calculation of the total efficiency began (UTC)

The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ssZ format.

calculationEndTime

ISO8601string

The date and time when the calculation of the total efficiency ended (UTC)

The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ssZ format.

totalRatio

string

The total efficiency of the entire storage system#

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

After a volume is created from a pool and before data is written to the volume, the maximum value (92233720368547758.07) is displayed.

compressionRatio

string

The efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) or accelerated compression#

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

snapshotRatio

string

The efficiency of capacity saving performed by using snapshots to back up data#

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

provisioningRate

string

The percentage (%) of saving efficiency for consumption of capacity achieved by using Dynamic Provisioning to virtualize capacity

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

dedupeAndCompression

object

Attributes related to the efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) are displayed.

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

  • totalRatio (string)

    total efficiency of capacity saving performed by using the capacity saving function#

  • compressionRatio (string)

    Efficiency of capacity saving performed by using compression#

  • dedupeRatio (string)

    Efficiency of capacity saving performed by using deduplication (dedupe)#

  • reclaimRatio (string)

    Efficiency of capacity saving performed by reclaiming the specified data pattern#

acceleratedCompression

object

Attributes related to the efficiency of capacity saving performed by using accelerated compression are displayed.

This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

  • totalRatio (string)

    Total efficiency of capacity saving performed by using accelerated compression#

  • compressionRatio (string)

    Efficiency of capacity saving performed by using compression#

  • reclaimRatio (string)

    Efficiency of capacity saving performed by reclaiming the specified data pattern#

#: This value represents the capacity before reduction as a ratio of the capacity after reduction, where the capacity after reduction is 1.

Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/total-efficiencies/instance