Get Vsan Health Check By Domain

Get vSAN health check status for all cluster on the domain

Request

URI

GET

https://{api_host}/v1/domains/{domainId}/health-checks

COPY

Path Parameters

string

domainId

Required

Domain ID

Query Parameters

string

status

Optional

Status of health check to filter by

Responses

202

Accepted

Returns HealthCheckQueryResult of type(s) application/json

{
    "resultId": "string",
    "status": "string",
    "result": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "type": "One among: VSAN",
            "status": "One among: ENABLED, DISABLED",
            "resourceType": "One among: CLUSTER",
            "resourceId": "string",
            "resourceName": "string"
        }
    ]
}

string

resultId

Required

Result id

string

status

Required

status

array of HealthCheckResult

result

Optional

result

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.