Get Health Check Query

Get vSAN health check status for all cluster on the domain

Request

URI

GET

https://sfo-vcf01.rainpole.io/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

200

Returns HealthCheckQueryResult of type(s) application/json

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

array of HealthCheckResult

result

Optional

result

string

resultId

Required

Result id

string

status

Required

status

202

Accepted

Returns HealthCheckQueryResult of type(s) application/json

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

array of HealthCheckResult

result

Optional

result

string

resultId

Required

Result id

string

status

Required

status

400

Bad Request

Returns Error of type(s) application/json

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

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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.

string

remediationMessage

Optional

The localized remediation error message

500

Internal Server Error

Returns Error of type(s) application/json

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

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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