Get Upgradables By Domain | VMware Cloud Foundation for VxRail API

Get Upgradables By Domain

Fetches the list of Upgradables for a given domain. If a target version is provided, Upgradables that are required for given target version become Available. The Upgradables providesinformation that can be use for Precheck API and also in the actual Upgrade API call.

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/upgradables/domains/{domainId}

COPY

Path Parameters

string

domainId

Required

Domain ID

Query Parameters

string

targetVersion

Optional

Target Version to get Upgradables for a given Target Release

Responses

200

Returns PageOfUpgradable of type(s) application/json

{
    "elements": [
        {
            "bundleId": "string",
            "bundleType": "string",
            "resource": {
                "fqdn": "string",
                "name": "string",
                "resourceId": "string",
                "sans": [
                    "string"
                ],
                "type": "string"
            },
            "softwareComponents": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "status": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of Upgradable

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

404

Domain not found

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).

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"
        }
    ],
    "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).