Vsan Performance Manager Query Vsan Perf Top Entities

Vsan Performance Manager Query Vsan Perf Top Entities

The API is designed to return a list of top contributors with either type of VM or disk group that are consuming the most IOPS, throughput or latency in the vSAN cluster.

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

string
release
Required

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

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

vSAN cluster, which is ignored if the API is called against host.

Required privileges: System.Read

querySpec
Required

Represent query specification to retrieve the desired top entities.

Authentication
This operation uses the following authentication methods.
Responses
200

A list of top entities with the expected metric values at the given time stamp.

[
    "VsanPerfEntityMetricCSV Object"
]
array of VsanPerfEntityMetricCSV
Optional

500

InvalidArgument: if the set of arguments passed to the function is not specified correctly, e.g., numEntities is above 50.

VsanNodeNotMaster: if this API is invokded against stats agent node.

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/VsanPerformanceManager/{moId}/QueryVsanPerfTopEntities
On This Page
V San Service Api Operations
POST
Vsan Performance Manager Vsan Perf Create Stats Object
POST
Vsan Performance Manager Vsan Perf Create Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Stats Object
POST
Vsan Performance Manager Vsan Perf Delete Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Time Range
POST
Vsan Performance Manager Vsan Perf Get Aggregated Entity Types
POST
Vsan Performance Manager Vsan Perf Get Supported Diagnostic Exceptions
POST
Vsan Performance Manager Vsan Perf Get Supported Entity Types
POST
Vsan Performance Manager Get Vsan Perf Diagnosis Result
POST
Vsan Performance Manager Vsan Perf Query Cluster Health
POST
Vsan Performance Manager Vsan Perf Query Node Information
POST
Vsan Performance Manager Query Remote Server Clusters
POST
Vsan Performance Manager Vsan Perf Query Stats Object Information
POST
Vsan Performance Manager Vsan Perf Query Time Ranges
POST
Vsan Performance Manager Vsan Perf Query Perf
POST
Vsan Performance Manager Query Vsan Perf Hotspot Entities
POST
Vsan Performance Manager Query Vsan Perf Top Entities
POST
Vsan Performance Manager Vsan Perf Save Time Ranges
POST
Vsan Performance Manager Vsan Perf Set Stats Object Policy
POST
Vsan Performance Manager Vsan Perf Toggle Verbose Mode
POST
Vsan Performance Manager Vsan Perf Diagnose
Deprecated
POST
Vsan Performance Manager Vsan Perf Diagnose Task