This API has a deprecated equivalent from v7.0U1.
Get Datastore
Retrieves information about the datastore indicated by datastore.
Request
URLURL
https://{api_host}/api/vcenter/datastore/{datastore}
Path Parameters
Path Parameters
string
datastore
Required
Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: Datastore.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DatastoreInfo
of type application/json
Information about the datastore associated with datastore.
{
"accessible": false,
"free_space": 0,
"multiple_host_access": false,
"name": "string",
"thin_provisioning_supported": false,
"type": "VMFS"
}
boolean
accessible
Required
Whether or not this datastore is accessible.
boolean
multiple_host_access
Required
Whether or not more than one host in the datacenter has been configured with access to the datastore.
string
name
Required
Name of the datastore.
boolean
thin_provisioning_supported
Required
Whether or not the datastore supports thin provisioning on a per file basis. When thin provisioning is used, backing storage is lazily allocated.
type
Required
The Datastore.Type enumerated type defines the supported types of vCenter datastores.
VMFS : VMware File System (ESX Server only).
NFS : Network file system v3 (linux & esx servers only).
NFS41 : Network file system v4.1 (linux & esx servers only).
CIFS : Common Internet File System.
VSAN : Virtual SAN (ESX Server only).
VFFS : Flash Read Cache (ESX Server only).
VVOL : vSphere Virtual Volume (ESX Server only).
Possible values are: VMFS , NFS , NFS41 , CIFS , VSAN , more...
integer
free_space
Optional
Available space of this datastore, in bytes. The server periodically updates this value.
This field will be unset if the available space of this datastore is not known.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the datastore indicated by datastore does not exist.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDatastore -Datastore "MyDatastore"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/datastore/{datastore}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/datastore/{datastore}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Datastore Operations
get
get
