Get Upgrade Preview

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

Request
URI
GET
https://{api_host}/v1/upgrades/preview
COPY
Query Parameters
string
bundleId
Required

Bundle Id

string
domainId
Optional

Domain Id


Responses
200

Success

Returns UpgradePreview of type(s) application/json
{
    "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"
                    }
                ]
            }
        }
    ]
}
object
bundle
Required

Represents a bundle reference

object
domain
Optional

Represents a domain reference

object
resourceMapper
Optional

Resource domain map for host cluster upgrade items

array of object
upgradeItems
Optional

Upgrade items for this preview


400

Bad Request Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

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
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


404

Bundle or Domain Not Found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

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
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Internal Server Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

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
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/upgrades/preview?bundleId=v