Vsan Vc Cluster Config System Vsan Cluster Get Runtime Stats

Vsan Vc Cluster Config System Vsan Cluster Get Runtime Stats

Get vSAN runtime stats of all hosts reside in specified cluster.

This API is used to retrieve vSAN runtime stats from all hosts reside in specified vSAN cluster. It bases on specified stats type list, to retrieve expected vSAN runtime stats. If host is out of reach, such as disconnected from vCenter, its stats will be ignored and unset.

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

string
release
Required

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

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

The target vCenter cluster

Required privileges: System.Read

array of string
stats
Optional

List of vSAN runtime stats type. Supported vSAN runtime stats types are declared in VsanHostStatsTypeEnum. If this parameter is omitted, all supported runtime stats will be collected and returned.

Authentication
This operation uses the following authentication methods.
Responses
200

vim.vsan.RuntimeStatsHostMap[] List of vSAN runtime stats, each item contains owner host and its stats. If specified cluster is empty, or vSAN is disabled on it, an empty list will be returned.

[
    "VsanRuntimeStatsHostMap Object"
]
array of VsanRuntimeStatsHostMap
Optional

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterGetRuntimeStats
On This Page
V San Service Api Operations
POST
Vsan Vc Cluster Config System Vsan Cluster Get Claimed Capacity
POST
Vsan Vc Cluster Config System Vsan Cluster Get Config
POST
Vsan Vc Cluster Config System Vsan Cluster Get Runtime Stats
POST
Vsan Vc Cluster Config System Vsan Query Cluster Drs Stats
POST
Vsan Vc Cluster Config System Vsan Cluster Reconfig
POST
Vsan Vc Cluster Config System Vsan Encrypted Cluster Rekey Task
POST
Vsan Vc Cluster Config System Run Lifecycle Check
POST
Vsan Vc Cluster Config System Vsan Validate Config Spec