Health Summary

Health Summary

Initiates Health Summary checks.

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/system/health-summary
COPY
Request Body

healthsummaryspec

HealthSummarySpec of type(s) application/json
Required
{
    "healthChecks": {
        "certificateHealth": false,
        "composabilityHealth": false,
        "computeHealth": false,
        "connectivityHealth": false,
        "dnsHealth": false,
        "generalHealth": false,
        "hardwareCompatibilityHealth": false,
        "ntpHealth": false,
        "passwordHealth": false,
        "servicesHealth": false,
        "storageHealth": false,
        "versionHealth": false
    },
    "options": {
        "config": {
            "force": false,
            "skipKnownHostCheck": false
        },
        "include": {
            "precheckReport": false,
            "summaryReport": false
        }
    },
    "scope": {
        "domains": [
            {
                "clusterNames": [
                    "string"
                ],
                "domainName": "string"
            }
        ],
        "includeAllDomains": false,
        "includeFreeHosts": false
    }
}
healthChecks
Optional

healthChecks

options
Optional

options

scope
Optional

scope

Responses
200

OK

Returns HealthSummary of type(s) application/json
{
    "bundleAvailable": "string",
    "bundleName": "string",
    "completionTimestamp": "string",
    "creationTimestamp": "string",
    "description": "string",
    "id": "string",
    "status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
bundleAvailable
Optional

Indicate if bundle is available in file system.

string
bundleName
Optional

Name of the Support Bundle.

string
completionTimestamp
Optional

CompletionTimestamp.

string
creationTimestamp
Optional

CreationTimestamp.

string
description
Optional

Name of the Operation.

string
id
Optional

Id of the Support Bundle task.

string
status
Optional

Health summary collection status.


202

Accepted

Returns HealthSummary of type(s) application/json
{
    "bundleAvailable": "string",
    "bundleName": "string",
    "completionTimestamp": "string",
    "creationTimestamp": "string",
    "description": "string",
    "id": "string",
    "status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
bundleAvailable
Optional

Indicate if bundle is available in file system.

string
bundleName
Optional

Name of the Support Bundle.

string
completionTimestamp
Optional

CompletionTimestamp.

string
creationTimestamp
Optional

CreationTimestamp.

string
description
Optional

Name of the Operation.

string
id
Optional

Id of the Support Bundle task.

string
status
Optional

Health summary collection status.


400

Bad request! Invalid Headers or Data. Error: {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).

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


401

Bad request! Authorization Header is missing or not in correct format.

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


409

Operation is in progress for Id {id}. Wait for the operation to complete.

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

Something went wrong. Internal server error occurred. Error {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).

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