Vsan Space Report System Query Vsan Managed Storage Space Usage

Vsan Space Report System Query Vsan Managed Storage Space Usage
Query the space usage including the space usage overview and the space usage breakdown based on different datastore types.

Query the space usage including the space usage overview and the space usage breakdown based on different datastore types.

The API can also be used to query physical capacity.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanSpaceReportSystem/{moId}/QueryVsanManagedStorageSpaceUsage
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
QueryVsanManagedStorageSpaceUsageRequestType of type(s) application/json
Required

Show optional properties

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

vSAN cluster

querySpec
Required

The QueryVsanManagedStorageSpaceUsageSpec to specify more detailed query specification.

Authentication
This operation uses the following authentication methods.
Responses
200

the space usage aggregated by different datastore type.

[
    {
        "_typeName": "string",
        "spaceUsage": {
            "_typeName": "string",
            "totalCapacityB": 0,
            "freeCapacityB": 0,
            "spaceOverview": {
                "_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
            },
            "spaceDetail": {
                "_typeName": "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
                    }
                ]
            },
            "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
            },
            "whatifCapacities": [
                {
                    "_typeName": "string",
                    "totalWhatifCapacityB": 0,
                    "freeWhatifCapacityB": 0,
                    "storagePolicy": {
                        "_typeName": "string"
                    },
                    "isSatisfiable": false
                }
            ],
            "uncommittedB": 0,
            "capacityHealthThreshold": {
                "_typeName": "string",
                "yellowValue": 0,
                "redValue": 0,
                "target": "string",
                "enabled": false
            },
            "spaceEfficiencyRatio": {
                "_typeName": "string",
                "overallRatio": "number",
                "compressionRatio": "number",
                "dedupRatio": "number",
                "dedupEnabledRatio": "number",
                "thinProvisionRatio": "number",
                "snapshotSavingRatio": "number"
            },
            "effectiveSpaceUsage": {
                "_typeName": "string",
                "totalUsableB": 0,
                "freeUsableB": 0,
                "actualWrittenB": 0,
                "overReservedB": 0,
                "totalProvisionB": 0,
                "snapshotSpace": {
                    "_typeName": "string",
                    "snapshotCount": 0,
                    "actualSnapshotUsedB": 0,
                    "fullyInflatedSnapshotUsedB": 0
                }
            }
        },
        "datastoreType": "string"
    }
]
array of object
Optional

Describe the vSAN space usage for the a specific datastore type.

The space usage will be aggregated according to the datastore type.

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


500

InvalidArgument: Exception for invalid input arguments, for example, if the querySpec contains invalid datastore type.

Returns InvalidArgument of type(s) application/json
This response body class contains all of the following: RuntimeFault 
{
    "_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"
        }
    ],
    "invalidProperty": "string"
}
string
invalidProperty
Optional

Optional name of the invalid property.


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}/QueryVsanManagedStorageSpaceUsage
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