List Datastore Deprecated
Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.
Request
URLURL
https://{api_host}/rest/vcenter/datastore
Query Parameters
Query Parameters
array of
string
filter.datacenters
Optional
Datacenters that must contain the datastore for the datastore to match the filter. If unset or empty, datastores in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.
array of
string
filter.datastores
Optional
Identifiers of datastores that can match the filter. If unset or empty, datastores with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datastore. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datastore.
array of
string
filter.folders
Optional
Folders that must contain the datastore for the datastore to match the filter. If unset or empty, datastores in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.
array of
string
filter.names
Optional
Names that datastores must have to match the filter (see Datastore.Info.name). If unset or empty, datastores with any name match the filter.
array of
DatastoreType
filter.types
Optional
Types that datastores must have to match the filter (see Datastore.Summary.type). If unset or empty, datastores with any type match the filter.
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
DatastoreListResponseBody of type application/json
Commonly used information about the datastores matching the Datastore.FilterSpec.
{
"value": [
{
"capacity": 0,
"datastore": "string",
"free_space": 0,
"name": "string",
"type": "VMFS"
}
]
}
array of
DatastoreSummary
value
Optional
Commonly used information about the datastores matching the Datastore.FilterSpec.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Datastore.FilterSpec.types field contains a value that is not supported by the server. if the Datastore.FilterSpec.types field contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 2500 datastores match the Datastore.FilterSpec.
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
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/datastore
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/datastore
x-vmw-doc-operation: list
On This Page
Datastore Operations
get
get
