Get Upgradables And Resource Errors

Fetches a class containing the list of Upgradables and list of Resource Upgradable Errors in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call. Resource Upgradable Errors are the errors collected related to upgrades for corresponding resources.

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/system/upgradables/compliance

COPY

Responses

200

Returns UpgradablesResource of type(s) application/json

{
    "resourceUpgradableErrors": [
        {
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "resource": {
                "fqdn": "sfo-vc01.rainpole.io",
                "name": "string",
                "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                "sans": [
                    "string"
                ],
                "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
            }
        }
    ],
    "upgradables": [
        {
            "bundleId": "string",
            "bundleType": "string",
            "resource": {
                "fqdn": "sfo-vc01.rainpole.io",
                "name": "string",
                "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                "sans": [
                    "string"
                ],
                "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
            },
            "softwareComponents": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "status": "string"
        }
    ]
}

array of ResourceUpgradableError

resourceUpgradableErrors

Optional

Set of resources with their corresponding upgradable errors.

array of Upgradable

upgradables

Optional

Set of upgradables representing the upgrade capability of resources.

500

Internal Server Error

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "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).