Host Vsan Health System Vsan Host Query Object Health Summary

Host Vsan Health System Vsan Host Query Object Health Summary

Query the object health status

Required privileges: System.Read

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

string
release
Required

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

Request Body
VsanHostQueryObjectHealthSummaryRequestType of type(s) application/json
Required 
"VsanHostQueryObjectHealthSummaryRequestType Object"
array of string
objUuids
Optional

The DOM object UUID list to be queried. None to query all of objects

boolean
includeObjUuids
Optional

True to include the object UUID list in the returned list and default is False

boolean
localHostOnly
Optional

True to only query the objects owned by the host and default is False

boolean
includeNonComplianceObjDetail
Optional

True to include all of non-compliant objects detail information. The default is False

spec
Optional

The additional query spec for object health. If the object health version is v2 VsanObjectHealthVersionEnum, it will try to convert v1 to v2 if not all of host can support the new object health version. If the object health version is unknown, it will always try to return the v2 object health version if all hosts support or return v1 if it doesn't

Authentication
This operation uses the following authentication methods.
Responses
200

The object health status query result

Returns VsanObjectOverallHealth of type(s) application/json 
"VsanObjectOverallHealth Object"
array of object
objectHealthDetail
Optional

The object health list each of which includes the health status, the number of objects on this health status and the object UUID list.

array of object
objectsComplianceDetail
Optional

The vSAN objects profile compliance check result

boolean
objectVersionCompliance
Optional

True to indicate all of the objects have compliant object version with the latest supported vSAN disk format.

The latest vSAN disk format version should be version 4 and the vSAN disk upgrade is needed when this flag is false

array of string
objectFormatChangeRequiredUuids
Optional

The vSAN objects which need object layout format change to get capacity improvement

integer As int64 As int64
objectsRelayoutBytes
Optional

The total bytes for objects need relayout

string
globalDedupStoreHealth
Optional

The global dedup store health that is value of the enum type vim.host.VsanObjectHealthState.

Global dedup store contains some hash objects and chunk objects, and the global dedup store health is an aggregation of each hash and chunk object health. Health will always pick the most serious hash or chunk object health as the global dedup store health.


500

Failure

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

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryObjectHealthSummary
On This Page
V San Service Api Operations
POST
Host Vsan Health System Vsan Host Clomd Liveness
POST
Host Vsan Health System Vsan Host Cleanup Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Create Vm Health Test
POST
Host Vsan Health System Vsan Flash Scsi Controller Firmware Task
Deprecated
POST
Host Vsan Health System Vsan Get Hcl Info
POST
Host Vsan Health System Vsan Get Network Diagnostics Health Info
POST
Host Vsan Health System Vsan Get Proactive Rebalance Info
POST
Host Vsan Health System Vsan Host Prepare Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Query Adv Cfg
POST
Host Vsan Health System Vsan Host Query Check Limits
POST
Host Vsan Health System Vsan Host Query Encryption Health Summary
POST
Host Vsan Health System Vsan Host Query File Service Health Summary
POST
Host Vsan Health System Vsan Query Host EMM State
POST
Host Vsan Health System Vsan Host Query Host Info By Uuids
POST
Host Vsan Health System Vsan Host Query Object Health Summary
POST
Host Vsan Health System Vsan Host Query Physical Disk Health Summary
POST
Host Vsan Health System Vsan Host Query Run Iperf Client
POST
Host Vsan Health System Vsan Host Query Run Iperf Server
POST
Host Vsan Health System Vsan Host Query Smart Stats
POST
Host Vsan Health System Vsan Host Query Verify Network Settings
POST
Host Vsan Health System Vsan Host Query Health System Version
POST
Host Vsan Health System Vsan Host Repair Immediate Objects
POST
Host Vsan Health System Vsan Host Run Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Start Proactive Rebalance
POST
Host Vsan Health System Vsan Stop Proactive Rebalance
POST
Host Vsan Health System Vsan Wait For Vsan Health Generation Id Change