Vsan Performance Manager Vsan Perf Query Cluster Health
This API shall not be used to query the health status for vSAN performance service.
This API shall not be used to query the health status for vSAN performance service.
Consider this API as deprecated. Use VsanQueryVcClusterHealthSummary instead.
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryClusterHealth
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.1.0.0 APIs.
Request Body
VsanPerfQueryClusterHealthRequestType
of type(s)
application/json
Required
Show optional properties
{
"cluster": {}
}{
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
cluster
Required
The cluster for which to compute health for.
Required privileges: System.Read
Responses
200
vim.cluster.VsanClusterHealthGroup[] A list of health groups.
[
{
"_typeName": "string",
"groupId": "string",
"groupName": "string",
"groupHealth": "string",
"groupTests": [
{
"_typeName": "string",
"testId": "string",
"testName": "string",
"testDescription": "string",
"testShortDescription": "string",
"testHealthyEntities": 0,
"testAllEntities": 0,
"testHealth": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testActions": [
{
"_typeName": "string",
"actionId": "string",
"actionLabel": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"actionDescription": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"enabled": false,
"parameters": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
}
],
"historicalResults": [
{
"_typeName": "string",
"timestamp": "string",
"health": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
}
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
},
"reducedScore": 0,
"category": "string",
"riskIfNotFix": "string",
"lastStatusChangeTime": "string"
}
],
"groupDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"inProgress": false
}
]
array of
object
This class defines vSAN cluster health group result.
The vSAN health check results with the same category will be grouped into a group result, which include the group name and ID, group health which is aggregated from each of health check item and the health check details
500
NotFound: if no ESXi host could be contacted to perform the operation when called against vCenter.
Returns
NotFound
of type(s)
application/json
This response body class contains all of the following:
VimFault
{
"_typeName": "string",
"faultCause": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfQueryClusterHealth
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 Vsan Perf Get Supported Hotspot 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