Vsan Space Report System Vsan Query Entity Space Usage

Vsan Space Report System Vsan Query Entity Space Usage
Query the vSAN space usage for the given vSAN object entities which contain a group of objects like the virtual machine with virtual disks backed by vSAN objects.

Query the vSAN space usage for the given vSAN object entities which contain a group of objects like the virtual machine with virtual disks backed by vSAN objects.

Note it can query maximum 100 entities' space usage in one call for performance consideration.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanSpaceReportSystem/{moId}/VsanQueryEntitySpaceUsage
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 VsanSpaceReportSystem/{moId}.

string
release
Required

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

Request Body
VsanQueryEntitySpaceUsageRequestType of type(s) application/json
Required

Show optional properties

{
    "cluster": {},
    "querySpec": {}
}
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "querySpec": {
        "_typeName": "string",
        "entityType": "string",
        "entityIds": [
            "string"
        ]
    }
}
cluster
Required

The vSAN cluster

Required privileges: System.Read

querySpec
Required

The vSAN space usage query spec to specify the entity types like virtual machine and the entity UUIDs like the managed object ID for virtual machines.

Authentication
This operation uses the following authentication methods.
Responses
200

The vSAN space usage for the vSAN entity

[
    {
        "_typeName": "string",
        "entityId": "string",
        "spaceUsageByObjectType": [
            {
                "_typeName": "string",
                "objType": "string",
                "overheadB": 0,
                "temporaryOverheadB": 0,
                "primaryCapacityB": 0,
                "provisionCapacityB": 0,
                "reservedCapacityB": 0,
                "overReservedB": 0,
                "physicalUsedB": 0,
                "usedB": 0,
                "objTypeExt": "string",
                "objTypeExtDesc": "string",
                "snapshotUsedB": 0
            }
        ],
        "totalCapacityB": 0,
        "freeCapacityB": 0,
        "efficientCapacity": {
            "_typeName": "string",
            "logicalCapacity": 0,
            "logicalCapacityUsed": 0,
            "physicalCapacity": 0,
            "physicalCapacityUsed": 0,
            "dedupMetadataSize": 0,
            "spaceEfficiencyMetadataSize": {
                "_typeName": "string",
                "dedupMetadataSize": 0,
                "compressionMetadataSize": 0
            },
            "esaDedupSpaceSaving": 0,
            "esaCompressionSpaceSaving": 0,
            "totalSpaceUsedWithoutOverhead": 0,
            "dedupEnabledObjectSpaceUsed": 0
        }
    }
]
array of object
Optional

This is base class describing the vSAN space usage for the general vSAN entity like virtual machine.

This structure may be used only with operations rendered under /vsan.


500

Failure

Returns MethodFault of type(s) application/json
This response body class contains all of the following: Any 
{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}","querySpec":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanSpaceReportSystem/{moId}/VsanQueryEntitySpaceUsage
On This Page
V San Service Api Operations
POST
Vsan Space Report System Vsan Query Entity Space Usage
POST
Vsan Space Report System Vsan Query Space Usage
POST
Vsan Space Report System Query Vsan Managed Storage Space Usage