Vsan Resource Check System Vsan Get Resource Check Status

Vsan Resource Check System Vsan Get Resource Check Status

Retrieve the status of the latest resource check.

If a resource check task is running, its status will be returned. Otherwise the status of the last resource check will be returned.

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

string
release
Required

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


Request Body
VsanGetResourceCheckStatusRequestType of type(s) application/json
Required
"VsanGetResourceCheckStatusRequestType Object"
resourceCheckSpec
Optional

The specification of the resource check to be queried. If it is not specified, VsanResourceCheckStatus will still be returned with VsanResourceCheckStatus.task and/or VsanResourceCheckStatus.parentTask information if such task is running in the specified cluster. However, VsanResourceCheckStatus.result will not be populated in this case.

cluster
Optional

The cluster to fetch the resource check status.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

The status of the specified resource check. The resource check may have not started yet, or be currently running, or have completed already. If a resource check has completed successfully, detailed resource check result will also be included.

Returns VsanResourceCheckStatus of type(s) application/json
"VsanResourceCheckStatus Object"
string
status
Required

The overall status of the resource check that is queried.

Please see VsanResourceCheckStatusTypeEnum for possible statuses.

See also VsanResourceCheckStatusTypeEnum.

result
Optional

The result of the resource check that is queried.

This field will be populated only if a resource check has completed successfully and recently, i.e., only when VsanResourceCheckStatus.status is "completed". For "EnterMaintenanceMode" operation, this will be the aggregated result for both regular vSAN and vSphere data persistence platform. For detailed result of each component, please look into VsanResourceCheckStatus.componentResults. For other resource check types, this will be the result for regular vSAN as usual. The same vSAN component result will also be in VsanResourceCheckStatus.componentResults.

task
Optional

The details of the resource check task that was generated and returned by VsanResourceCheckSystem.VsanPerformResourceCheck.

It will be set only when VsanResourceCheckStatus.status is "resourceCheckRunning". The derived class VsanDiskDataEvacuationResourceCheckTaskDetails will be used if the resource check task is for disk/disk-group data evacuation.

parentTask
Optional

The details of the parent task passed in by VsanResourceCheckSpec.parent.

It will be set only when the resource check is launched from a parent task and the state of the parent task is "running".

array of object
componentResults
Optional

The detailed resource check result for different components.

The data persistence component resource check result is only available when the operation is "EnterMaintenanceMode" at the moment. For other resource check types, only the regular vSAN result will be available.


500

NotSupported: if run directly on an ESX Server host.

InvalidArgument: Exception when the given operation is not supported, some parameter is missing or incorrect in the spec. For example, for host enter maintenance mode operation, host vSAN UUID or maintenanceSpec is not provided, or data evacuation mode is not supported.

VsanFault: If any error happens when retrieving the resource check status.

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/VsanResourceCheckSystem/{moId}/VsanGetResourceCheckStatus