Vsan Vc Cluster Health System Vsan Query Cluster Historical Health

It queries vSAN cluster historical health information based on the query spec.

Query general historical health summary. If no groupId and testId specified in the query spec, it aggregates all the historical vSAN cluster health status for the given time range. Then returns a general health summary with only overallHealth, test group IDs, group healths, test IDs and test healths.
Query health status history for a certain health check. If groupId and testId are specified, and start time doesn't equal to end time, the result will only contain the historical testHealths for the given time range of the target health check.
Query a snapshot detail for a certain health check. If groupId and testId are specified, and start time equals to end time, the result will contain a full testDetail for the certain timestamp of the target health check.

Required privileges: System.Read

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanQueryClusterHistoricalHealth

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 VsanVcClusterHealthSystem/{moId}.

string

release

Required

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

Request Body

VsanQueryClusterHistoricalHealthRequestType of type(s) application/json

Required

"VsanQueryClusterHistoricalHealthRequestType Object"

spec

Required

The query spec.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vSAN cluster health summary with historical infomation.

[
    "VsanClusterHealthSummary Object"
]

array of VsanClusterHealthSummary

Optional

500

NotSupported: if run directly on an ESX Server host.

InvalidArgument: Exception for invalid input arguments. For example, if given time range is more than one month. Or end time is smaller than the start time.

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/VsanVcClusterHealthSystem/{moId}/VsanQueryClusterHistoricalHealth

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations