List Data Sets
Lists the data sets of a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetList.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/data-sets
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.
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
array of
VmDataSetsSummary
of type application/json
The list of data sets.
[
{
"data_set": "string",
"description": "string",
"name": "string"
}
]
string
data_set
Required
The identifier of the data set. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
string
description
Required
The description of the data set.
string
name
Required
The name of the data set.
Errors
400
com.vmware.vapi.std.errors.unsupported : if the virtual hardware version of the virtual machine does not support DataSets if the ESXi host version does not support DataSets
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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-ListVmDataSets -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/data-sets
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.0
On This Page
Data Sets Operations
get
post
get
patch
delete
