Vsan Cluster Power System Query Cluster Power Context

Vsan Cluster Power System Query Cluster Power Context

Query the ClusterPowerContext.

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

string
release
Required

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

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

The cluster which to query ClusterPowerContext.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

ClusterPowerContext

Returns ClusterPowerContext of type(s) application/json 
"ClusterPowerContext Object"
string
currentClusterPowerStatus
Required

The current ClusterPowerStatus.

See also ClusterPowerStatusEnum.

array of string
orderedClusterPowerStatus
Optional

A full list of ClusterPowerStatus with its corresponding executing order to final status.

It contains only the relevant actions based on the target ClusterPowerStatus.

See also ClusterPowerStatusEnum.

trackingTask
Optional

A task that is executing the power action.

None is returned if there is no on-going task

lastErrorMessage
Optional

The description of error message if the previous task failed.

array of object
lastErrorMOs
Optional

The MO list that causes the previous task to fail.

i.e. if previous task failed because of having not powered-off VMs during power off cluster, the list contains some of the not powered-off VMs.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterPowerSystem/{moId}/QueryClusterPowerContext
On This Page
V San Service Api Operations
POST
Vsan Cluster Power System Perform Cluster Power Action
POST
Vsan Cluster Power System Query Cluster Power Context
POST
Vsan Cluster Power System Update Cluster Power Status