Pbm Profile Profile Manager Pbm Query Space Stats For Storage Container

Retrieves space statistics of a datastore.

Required privileges: StorageProfile.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmProfileProfileManager/{moId}/PbmQuerySpaceStatsForStorageContainer

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 PbmProfileProfileManager/{moId}.

string

release

Required

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

Request Body

PbmQuerySpaceStatsForStorageContainerRequestType of type(s) application/json

Required

Show optional properties

{
    "datastore": {
        "objectType": "string",
        "key": "string"
    }
}

{
    "datastore": {
        "_typeName": "string",
        "objectType": "string",
        "key": "string",
        "serverUuid": "string"
    },
    "capabilityProfileId": [
        {
            "_typeName": "string",
            "uniqueId": "string"
        }
    ]
}

PbmServerObjectRef

datastore

Required

The PbmServerObjectRef data object identifies a virtual machine, virtual disk attached to a virtual machine, a first class storage object or a datastore.

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

array of PbmProfileId

capabilityProfileId

Optional

- capability profile Ids. If omitted, the statistics for the container as a whole would be returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Array of Space stats of datastore for each capabilityProfileId.

Returns Array of PbmDatastoreSpaceStatistics of type(s) application/json

[
    {
        "_typeName": "string",
        "profileId": "string",
        "physicalTotalInMB": 0,
        "physicalFreeInMB": 0,
        "physicalUsedInMB": 0,
        "logicalLimitInMB": 0,
        "logicalFreeInMB": 0,
        "logicalUsedInMB": 0
    }
]

500

InvalidArgument: - Thrown if the input datastore parameter is null or its type is not datastore or its key is empty.

PbmFault: - Thrown if server internal error occurred or if storage container does not support the profile.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

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.

On This Page

Description

Request

Path Parameters