Get Vsan Health Check By Domain

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 object
result
Optional

result


500

InternalServerError

Returns Error of type(s) application/json 
"Error Object"
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.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/domains/{domainId}/health-checks
On This Page
V Sanhealth Check Operations
GET
Get Vsan Health Check By Domain
PATCH
Update Vsan Health Check By Domain
GET
Get Vsan Health Check By Task ID
GET
Get Vsan Health Check By Query ID