Vcenter V Storage Object Manager Retrieve V Storage Object

Retrieve a virtual storage object.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/RetrieveVStorageObject

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 VcenterVStorageObjectManager/{moId}.

string

release

Required

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

Request Body

RetrieveVStorageObjectRequestType of type(s) application/json

Required

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "diskInfoFlags": [
        "string"
    ]
}

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

array of string

diskInfoFlags

Optional

Flags indicating the FCD information to be retrieved. If diskInfoFlags is unset, then all FCD information will be retrieved. See vslmDiskInfoFlagEnum for the list of supported values.

Since: vSphere API Release 8.0.0.1

Authentication

This operation uses the following authentication methods.

Session

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"
            }
        ]
    }
}

VStorageObjectConfigInfo

config

Required

Data object specifies 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.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Vcenter Vstorage Object Manager Operations