Vslm V Storage Object Manager Vslm Retrieve V Storage Object
Retrieve a virtual storage object.
Retrieve a virtual storage object.
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmRetrieveVStorageObject
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 VslmVStorageObjectManager/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.
Request Body
VslmRetrieveVStorageObjectRequestType
of type(s)
application/json
Required
Show optional properties
{
"id": {}
}{
"id": {
"_typeName": "string",
"id": "string"
}
}
id
Required
The ID of the virtual storage object to be retrieved.
Responses
200
The required virtual storage object.
Returns
VStorageObject
of type(s)
application/json
This response body class contains all of the following:
DataObject
{
"_typeName": "string",
"config": {
"_typeName": "string",
"id": {
"_typeName": "string",
"id": "string"
},
"name": "string",
"createTime": "string",
"keepAfterDeleteVm": false,
"relocationDisabled": false,
"nativeSnapshotSupported": false,
"changedBlockTrackingEnabled": false,
"backing": {
"_typeName": "string",
"datastore": {
"_typeName": "string",
"type": "string",
"value": "string"
}
},
"metadata": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"vclock": {
"_typeName": "string",
"vClockTime": 0
},
"iofilter": [
"string"
],
"descriptorVersion": 0,
"capacityInMB": 0,
"consumptionType": [
"string"
],
"consumerId": [
{
"_typeName": "string",
"id": "string"
}
],
"virtualDiskFormat": "string",
"linkedCloneBasePath": "string",
"linkedCloneParentId": {
"_typeName": "string",
"id": "string"
}
}
}
config
Required
Virtual storage object configuration
500
FileFault: If an error occurs when retrieving the virtual object.
InvalidDatastore: If the operation cannot be performed on the datastore.
NotFound: If specified virtual storage object cannot be found.
VslmFault: If a VSLM internal server error occurred.
Returns
MethodFault
of type(s)
application/json
This response body class contains all of the following:
Any
{
"_typeName": "string",
"faultCause": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
faultCause
Optional
Fault which is the cause of this fault.
array of
object
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.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id":"{}"}' https://{api_host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmRetrieveVStorageObject
On This Page
Storage Lifecycle Management Operations
POST
Vslm V Storage Object Manager Vslm Attach Disk Task
POST
Vslm V Storage Object Manager Vslm Attach Tag To V Storage Object
POST
Vslm V Storage Object Manager Vslm Clear V Storage Object Control Flags
POST
Vslm V Storage Object Manager Vslm Clone V Storage Object Task
POST
Vslm V Storage Object Manager Vslm Create Disk Task
POST
Vslm V Storage Object Manager Vslm Create Disk From Snapshot Task
POST
Vslm V Storage Object Manager Vslm Create Snapshot Task
POST
Vslm V Storage Object Manager Vslm Delete Snapshot Task
POST
Vslm V Storage Object Manager Vslm Delete V Storage Object Task
POST
Vslm V Storage Object Manager Vslm Detach Tag From V Storage Object
POST
Vslm V Storage Object Manager Vslm Extend Disk Task
POST
Vslm V Storage Object Manager Vslm Inflate Disk Task
POST
Vslm V Storage Object Manager Vslm List Tags Attached To V Storage Object
POST
Vslm V Storage Object Manager Vslm List V Storage Objects Attached To Tag
POST
Vslm V Storage Object Manager Vslm List V Storage Object For Spec
POST
Vslm V Storage Object Manager Vslm Query Changed Disk Areas
POST
Vslm V Storage Object Manager Vslm Query Global Catalog Sync Status
POST
Vslm V Storage Object Manager Vslm Query Global Catalog Sync Status For Datastore
POST
Vslm V Storage Object Manager Vslm Reconcile Datastore Inventory Task
POST
Vslm V Storage Object Manager Vslm Register Disk
POST
Vslm V Storage Object Manager Vslm Relocate V Storage Object Task
POST
Vslm V Storage Object Manager Vslm Rename V Storage Object
POST
Vslm V Storage Object Manager Vslm Retrieve Snapshot Details
POST
Vslm V Storage Object Manager Vslm Retrieve Snapshot Info
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Infrastructure Object Policy
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Object
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Object Associations
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Object Metadata
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Object Metadata Value
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Object State
POST
Vslm V Storage Object Manager Vslm Retrieve V Storage Objects
POST
Vslm V Storage Object Manager Vslm Revert V Storage Object Task
POST
Vslm V Storage Object Manager Vslm Schedule Reconcile Datastore Inventory
POST
Vslm V Storage Object Manager Vslm Set V Storage Object Control Flags
POST
Vslm V Storage Object Manager Vslm Update V Storage Infrastructure Object Policy Task
POST
Vslm V Storage Object Manager Vslm Update Vstorage Object Crypto Task
POST
Vslm V Storage Object Manager Vslm Update V Storage Object Metadata Task
POST
Vslm V Storage Object Manager Vslm Update Vstorage Object Policy Task