Precheck System
Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck
Precheck System Spec
Show optional properties
{
"resources": [
{
"resourceId": "string",
"type": "string"
}
]
}{
"bundleId": "string",
"mode": "string",
"resources": [
{
"fqdn": "string",
"name": "string",
"resourceId": "string",
"sans": [
"string"
],
"type": "string"
}
]
}If specified, indicate the bundle applicability in the result
If specified, indicates the mode of the execution. Supported modes are UPGRADE and RECOVERY. UPGRADE is default mode. Specify RECOVERY for the Inventory Consistency Checks
List of resources for Precheck supported type DOMAIN, CLUSTER
OK
"Task Object"Task completion timestamp
Task creation timestamp
List of errors in case of a failure
Task ID
Represents task can be cancellable or not.
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
Task name
Resolution state
List of resources associated with task
Task status
List of sub-tasks of the task
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Accepted
"Task Object"Task completion timestamp
Task creation timestamp
List of errors in case of a failure
Task ID
Represents task can be cancellable or not.
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
Task name
Resolution state
List of resources associated with task
Task status
List of sub-tasks of the task
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Bad Request
"Error Object"The arguments used to localize the message, Can be used by scripts to automate the error processing.
The underlying cause exceptions.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Internal Server Error
"Error Object"The arguments used to localize the message, Can be used by scripts to automate the error processing.
The underlying cause exceptions.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"resources":["string"]}' https://{api_host}/v1/system/prechecks