Vsan Performance Manager Vsan Perf Query Node Information

Query performance service related information about the node(s).

Always returns a list, but when run against the host the list is guaranteed to have length=1. If run against vCenter, information about all hosts in the cluster is retrieved. If information of one host can not be retrieved, there are 2 situations:

If the host is connected: it will throw "invalid Request", "method fault", "vsan fault" or other run time exception message.
If the host is not connected, it will throw "host is not in connected status" message.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryNodeInformation

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

VsanPerfQueryNodeInformationRequestType of type(s) application/json

Required

"VsanPerfQueryNodeInformationRequestType Object"

cluster

Optional

vSAN cluster. Ignored if called against host.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

[
    "VsanPerfNodeInformation Object"
]

array of VsanPerfNodeInformation

Optional

500

Failure

Returns NotSupported of type(s) application/json

"NotSupported Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryNodeInformation

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations