Get Upgrade By Id

Get Upgrade By Id

Get Upgrade By Id

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/upgrades/{upgradeId}
COPY
Path Parameters
string
upgradeId
Required

upgradeId


Responses
200

OK

Returns Upgrade of type(s) application/json
{
    "bundleId": "string",
    "id": "string",
    "nsxtUpgradeUserInputSpec": {
        "nsxtEdgeClusterUpgradeSpecs": [
            {
                "edgeClusterId": "string",
                "edgeParallelUpgrade": false
            }
        ],
        "nsxtHostClusterUpgradeSpecs": [
            {
                "hostClusterId": "string",
                "hostParallelUpgrade": false,
                "liveUpgrade": false
            }
        ],
        "nsxtId": "string",
        "nsxtUpgradeOptions": {
            "isEdgeClustersUpgradeParallel": false,
            "isEdgeOnlyUpgrade": false,
            "isHostClustersUpgradeParallel": false
        }
    },
    "parallelUpgrade": false,
    "resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
    "resourceUpgradeSpecs": [
        {
            "customISOSpec": {
                "hostIds": [
                    "string"
                ],
                "id": "string"
            },
            "enableQuickboot": false,
            "evacuateOfflineVms": false,
            "personalitySpec": {
                "hardwareSupportSpecs": [
                    {
                        "name": "string",
                        "packageSpec": {
                            "name": "string",
                            "version": "string"
                        }
                    }
                ],
                "personalityId": "string"
            },
            "resourceId": "string",
            "scheduledTimestamp": "string",
            "shutdownVms": false,
            "toVersion": "string",
            "upgradeNow": false
        }
    ],
    "status": "string",
    "taskId": "string"
}
string
bundleId
Required

Bundle ID for Upgrade

string
id
Required

ID for Upgrade

nsxtUpgradeUserInputSpec
Optional

nsxtUpgradeUserInputSpec

boolean
parallelUpgrade
Optional

Boolean to represent components will be upgraded in parallel on not

string
resourceType
Required

Resource Type for Upgrade

resourceUpgradeSpecs
Required

Resource Upgrade Specifications

string
status
Required

Overall upgrade status

string
taskId
Required

Task ID associated with upgrade


404

Upgrade not found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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

Internal Server Error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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