Vsan Object System Vos Query Vsan Object Information

Vsan Object System Vos Query Vsan Object Information

Get information about the vSAN object/directory.

If it's called in VC, the spbmProfileGenerationId can be safely ignored in vim.cluster.VsanObjectQuerySpec, it will be automatically set to the correct value by using SPBM service. If it's called in host with MOID 'vsan-object-system', both fields in VsanObjectQuerySpec should be provided, if spbmProfileGenerationId is not provided, the one from vSAN CMMDS will be used here, as a result, the mismatch field for storage compliance result is not reliable in some cases, e.g. profile is updated or deleted in vCenter after the vSAN object creation. If it's called in host with MOID 'vsan-cluster-object-system', the spbmProfileGenerationId in VsanObjectQuerySpec would be ignored and mismatch field is not reliable. Note this API can query maximum 500 vSAN objects at once when it's called from ESXi host for performance consideration, otherwise, the InvalidArgument exception will be thrown.

If the vSAN object can not be found, FileNotFound exception will be raised. If the vSAN object failed to read the policy, e.g. because it is not accessible, FileNotReadable exception will be raised.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/VosQueryVsanObjectInformation
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 VsanObjectSystem/{moId}.

string
release
Required

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

Request Body
VosQueryVsanObjectInformationRequestType of type(s) application/json
Required 
"VosQueryVsanObjectInformationRequestType Object"
cluster
Optional

vSAN cluster. Ignored if called against host.

Required privileges: System.Read

array of object
vsanObjectQuerySpecs
Required

vSAN object query spec list.

Authentication
This operation uses the following authentication methods.
Responses
200

Object information list.

[
    "VsanObjectInformation Object"
]
array of VsanObjectInformation
Optional

500

Failure

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0 
"MethodFault Object"
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 '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/VosQueryVsanObjectInformation
On This Page
V San Service Api Operations
POST
Vsan Object System Vsan Delete Objects Task
POST
Vsan Object System Vsan Query Inaccessible Vm Swap Objects
POST
Vsan Object System Vsan Query Object Identities
POST
Vsan Object System Query Syncing Vsan Objects Summary
POST
Vsan Object System Vos Query Vsan Object Information
POST
Vsan Object System Relayout Objects
POST
Vsan Object System Vos Set Vsan Object Policy