Start Health Check
Start a Health Check operation using SoS
{
"options": {
"config": {
"skipKnownHostCheck": false,
"force": false
},
"include": {
"summaryReport": false,
"precheckReport": false
}
},
"scope": {
"includeFreeHosts": false,
"includeAllDomains": false,
"domains": [
{
"domainName": "string",
"clusterNames": [
"string"
]
}
]
},
"healthChecks": {
"servicesHealth": false,
"ntpHealth": false,
"generalHealth": false,
"certificateHealth": false,
"passwordHealth": false,
"connectivityHealth": false,
"computeHealth": false,
"storageHealth": false,
"dnsHealth": false,
"hardwareCompatibilityHealth": false,
"versionHealth": false
}
}Sos options for support health checks.
Domain and cluster under which logs should be collected.
Sos Health Checks.
Accepted
"HealthSummary Object"Health summary collection status.
CreationTimestamp.
Name of the Operation.
Indicate if bundle is available in file system.
Id of the Support Bundle task.
CompletionTimestamp.
Name of the Support Bundle.
Bad request! Invalid Headers or Data. Error: {error}
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Bad request! Authorization Header is missing or not in correct format.
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Operation is in progress for Id {id}. Wait for the operation to complete.
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Something went wrong. Internal server error occurred. Error {error}
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/system/health-summary