Get Upgrade Preview
Get the list of resources for a given domain which the bundle will be applied; Note: Domain ID is ignored for SDDC Manager (EVORACK) bundle type since the bundle is always applied to all the management domains
Bundle Id
Domain Id
Success
{
"bundle": {
"id": "string"
},
"domain": {
"id": "string",
"name": "string",
"type": "string"
},
"resourceMapper": {
"resourceMapper": "string"
},
"upgradeItems": [
{
"resourceId": "string",
"bundleComponentType": "string",
"upgradeEligibility": {
"status": "One among: ELIGIBLE, NOT_ELIGIBLE, SKIPPED, NOT_AVAILABLE",
"details": [
{
"name": "string",
"description": "string",
"status": "One among: PASSED, FAILED, SKIPPED, NOT_AVAILABLE",
"reasonCode": "string",
"remediationCode": "string"
}
]
}
}
]
}Represents a bundle reference
Represents a domain reference
Resource domain map for host cluster upgrade items
Upgrade items for this preview
Bad Request Error
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}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).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Bundle or Domain Not Found
"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).
Detailed results of the precheck validation.
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.
The localized label message
The URL string for remediation documentation link
Internal Server 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).
Detailed results of the precheck validation.
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.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/upgrades/preview?bundleId=v