Vsan Performance Manager Vsan Perf Query Stats Object Information

Get information about the vSAN object/directory containing the vSAN Perf Stats DB.

If the statsDB object can not be found, FileNotFound exception will be raised. If the statsDB object failed to read the policy, e.g. because it is not accessible, FileNotWritable exception will be raised. If called against vCenter, but no ESXi host could be contacted to perform the operation NotFound exception will be raised.

Request

URI

POST

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

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

VsanPerfQueryStatsObjectInformationRequestType of type(s) application/json

Required

"VsanPerfQueryStatsObjectInformationRequestType 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

Object information structure

Returns VsanObjectInformation of type(s) application/json

"VsanObjectInformation Object"

string

directoryName

Optional

The friendly name of a namespace object.

string

vsanObjectUuid

Optional

vSAN object UUID.

If not set, object couldn't be found in the current cluster.

string

vsanHealth

Optional

Health of the vSAN object, as seen by the host.

The possible value is 'inaccessible', 'reduced-availability-with-no-rebuild', 'reduced-availability-with-no-rebuild-delay-timer', 'reduced-availability-with-active-rebuild', 'data-move', 'non-availability-related-reconfig', 'non-availability-related-incompliance', 'healthy'

array of object

policyAttributes

Optional

vSAN policy attributes used for the policy of the object.

Not set if the object couldn't be found, or if the object is not healthy enough to determine its policy. Its format is key-value pair list, each key-value pair represents one attribute, the key is the attribute name, the value is the attribute value represented by string format.

string

spbmProfileUuid

Optional

UUID of SPBM profile used for the policy of the object when it was applied to vSAN Object.

Not set if the object couldn't be found, if the object is not healthy enough to determine its policy, or if the object doesn't use a SPBM managed policy.

string

spbmProfileGenerationId

Optional

Generation ID of SPBM profile used for the policy of the object when it was applied to vSAN Object.

Not set if the object couldn't be found, if the object is not healthy enough to determine its policy, or if the object doesn't use a SPBM managed policy.

spbmComplianceResult

Optional

Describes the results of profile compliance checking for a vSAN object.

500

NotFound: if no ESXi host could be contacted to perform the operation when called against vCenter.

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}/VsanPerfQueryStatsObjectInformation

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Performance Manager Vsan Perf Create Stats Object