Set Health Check Status

Set Health Check Status

Update vSAN health check status for domain

Request
URI
PATCH
https://sfo-vcf01.rainpole.io//v1/domains/{domainId}/health-checks
COPY
Path Parameters
string
domainId
Required

Domain ID


Request Body

Health check update spec

Array of HealthCheckSpec of type(s) application/json
Optional
[
    {
        "id": "string",
        "name": "string",
        "resourceName": "string",
        "resourceType": "string",
        "status": "string"
    }
]
Responses
200

OK

Returns HealthCheckTask of type(s) application/json
{
    "id": "string",
    "status": "string"
}
string
id
Required

Health Check task id

object
resourceStatus
Required

Health Check resource status

string
status
Required

Health Check task status


202

Accepted

Returns HealthCheckTask of type(s) application/json
{
    "id": "string",
    "status": "string"
}
string
id
Required

Health Check task id

object
resourceStatus
Required

Health Check resource status

string
status
Required

Health Check task status


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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"
        }
    ],
    "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