Vim Cluster Vsan Vc Disk Management System Query Cluster Data Efficiency Capacity State

Vim Cluster Vsan Vc Disk Management System Query Cluster Data Efficiency Capacity State

Retrieve logical capacity, logical capacity used, physical capacity, physical capacity used and data efficiency metadata of a data efficiency enabled cluster.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryClusterDataEfficiencyCapacityState
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VimClusterVsanVcDiskManagementSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
QueryClusterDataEfficiencyCapacityStateRequestType of type(s) application/json
Required 
"QueryClusterDataEfficiencyCapacityStateRequestType Object"
cluster
Required

The target cluster.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VimVsanDataEfficiencyCapacityState of type(s) application/json 
"VimVsanDataEfficiencyCapacityState Object"
integer As int64 As int64
logicalCapacity
Optional

Total logical capacity in bytes.

integer As int64 As int64
logicalCapacityUsed
Optional

Logical capacity used in bytes by aggregating all vSAN disks usage including all kinds of overhead.

integer As int64 As int64
physicalCapacity
Optional

Total physical capacity in bytes.

integer As int64 As int64
physicalCapacityUsed
Optional

Physical capacity used in bytes by aggregating all vSAN disks usage including all kinds of overhead.

integer As int64 As int64
dedupMetadataSize
Optional

Size of space used for deduplication metadata in bytes.

spaceEfficiencyMetadataSize
Optional

vSAN space efficiency metadata size in bytes.

integer As int64 As int64
esaDedupSpaceSaving
Optional

Total space saving in bytes by deduplication when storing regular vSAN objects on vSAN ESA.

Notice it doesn't include the space saving from RAID efficiency as we may store the deduplicated data with more RAID efficient way. This is only valid since 9.0.

integer As int64 As int64
esaCompressionSpaceSaving
Optional

Total space saving in bytes by compression when storing regular vSAN objects on vSAN ESA.

Notice it doesn't include the space saving from RAID efficiency as we may store the compressed data with more RAID efficient way. This is only valid since 9.0.

integer As int64 As int64
totalSpaceUsedWithoutOverhead
Optional

Total space used in bytes when storing regular vSAN objects on vSAN ESA after deduplication and compression, including space used by regular objects and dedup store, any other overhead including RAID will be excluded.

This is only valid since 9.0.


500

Failure

Returns VsanFault of type(s) application/json 
"VsanFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryClusterDataEfficiencyCapacityState
On This Page
V San Service Api Operations
POST
Vim Cluster Vsan Vc Disk Management System Vsan Add Storage Pool Disk
POST
Vim Cluster Vsan Vc Disk Management System Vsan Delete Storage Pool Disk
POST
Vim Cluster Vsan Vc Disk Management System Initialize Disk Mappings
POST
Vim Cluster Vsan Vc Disk Management System Query Cluster Data Efficiency Capacity State
POST
Vim Cluster Vsan Vc Disk Management System Query Disk Mappings
POST
Vim Cluster Vsan Vc Disk Management System Query Vsan Managed Disks
POST
Vim Cluster Vsan Vc Disk Management System Rebuild Disk Mapping
POST
Vim Cluster Vsan Vc Disk Management System Remove Disk Ex
POST
Vim Cluster Vsan Vc Disk Management System Remove Disk Mapping Ex
POST
Vim Cluster Vsan Vc Disk Management System Retrieve All Flash Capabilities
POST
Vim Cluster Vsan Vc Disk Management System Unmount Disk Mapping Ex
POST
Vim Cluster Vsan Vc Disk Management System Vsan Unmount Storage Pool Disks