Datastore Get Summary | Virtual Infrastructure JSON API

Datastore Get Summary

Global properties of the datastore.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/Datastore/{moId}/summary

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns DatastoreSummary of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "name": "string",
    "url": "string",
    "capacity": 0,
    "freeSpace": 0,
    "uncommitted": 0,
    "accessible": false,
    "multipleHostAccess": false,
    "type": "string",
    "maintenanceMode": "string"
}

MoRefDatastore

datastore

Optional

Reference to an instance of the Datastore managed object.

string

name

Required

The name of the datastore.

string

url

Required

The unique locator for the datastore.

This property is guaranteed to be valid only if DatastoreSummary.accessible is true.

integer As int64 As int64

capacity

Required

Maximum capacity of this datastore, in bytes.

This value is updated periodically by the server. It can be explicitly refreshed with the Refresh operation. This property is guaranteed to be valid only if DatastoreSummary.accessible is true.

integer As int64 As int64

freeSpace

Required

Available space of this datastore, in bytes.

The server periodically updates this value. It can be explicitly refreshed with the Refresh operation. This property is guaranteed to be valid only if DatastoreSummary.accessible is true.

integer As int64 As int64

uncommitted

Optional

Total additional storage space, in bytes, potentially used by all virtual machines on this datastore.

The server periodically updates this value. It can be explicitly refreshed with the Datastore.RefreshDatastoreStorageInfo operation. This property is valid only if DatastoreSummary.accessible is true.

boolean

accessible

Required

The connectivity status of this datastore.

If this is set to false, meaning the datastore is not accessible, this datastore's capacity and freespace properties cannot be validated. Furthermore, if this property is set to false, some of the properties in this summary and in DatastoreInfo should not be used. Refer to the documentation for the property of your interest. For datastores accessed from multiple hosts, vCenter Server reports DatastoreSummary.accessible as an aggregated value of the properties reported in HostMountInfo. For instance, if a datastore is accessible through a subset of hosts, then the value of DatastoreSummary.accessible will be reported as true by vCenter Server. And the reason for a daastore being inaccessible from a host will be reported in HostMountInfo.inaccessibleReason

boolean

multipleHostAccess

Optional

More than one host in the datacenter has been configured with access to the datastore.

This is only provided by VirtualCenter.

string

type

Required

Type of file system volume, such as VMFS or NFS.