Get Upgrade Unit Aggregate Info

Get upgrade units aggregate-info

Request

URI

GET

https://nsxmanager.your.domain/api/v1/upgrade/upgrade-units/aggregate-info

COPY

Query Parameters

string

component_type

Optional

Component type based on which upgrade units to be filtered

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

group_id

Optional

Identifier of group based on which upgrade units to be filtered

boolean

has_errors

Optional

Flag to indicate whether to return only upgrade units with errors

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

metadata

Optional

Metadata about upgrade unit to filter on

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

selection_status

Optional

Flag to indicate whether to return only selected, only deselected or both type of upgrade units

Possible values are : SELECTED, DESELECTED, ALL,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns UpgradeUnitAggregateInfoListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineUpgradeUnitAggregateInfoListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "status": "string",
            "errors": [
                "string"
            ],
            "group": {
                "display_name": "string",
                "id": "string"
            },
            "display_name": "string",
            "warnings": [
                "string"
            ],
            "current_version": "string",
            "percent_complete": "number",
            "type": "string",
            "id": "string",
            "metadata": [
                {
                    "value": "string",
                    "key": "string"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error