Vsan Object System Query Syncing Vsan Objects Summary

Vsan Object System Query Syncing Vsan Objects Summary

Query summary information about the syncing objects in this cluster.

It will retrieve information about syncing objects based on object filter options.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/QuerySyncingVsanObjectsSummary
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
Required
"QuerySyncingVsanObjectsSummaryRequestType Object"
cluster
Required

vSAN cluster.

Required privileges: System.Read

syncingObjectFilter
Optional

Filter spec for summary.

Authentication
This operation uses the following authentication methods.
Responses
200

result VsanSyncingObjectQueryResult.

Returns VsanHostVsanObjectSyncQueryResult of type(s) application/json
"VsanHostVsanObjectSyncQueryResult Object"
integer As int64 As int64
totalObjectsToSync
Optional

Total number of vSAN objects that are syncing.

It's returned only when summary data is needed.

integer As int64 As int64
totalBytesToSync
Optional

The amount of data to be re-synced.

It's returned only when summary data is needed.

integer As int64 As int64
totalRecoveryETA
Optional

The estimated time in seconds to recover all vSAN objects of specified types.

It's returned only when summary data is needed.

array of object
objects
Optional

The retrieved objects.

syncingObjectRecoveryDetails
Optional

Details returned from querying vSAN syncing objects for different sync status.


500

Failure

Returns NotSupported of type(s) application/json
"NotSupported Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/QuerySyncingVsanObjectsSummary