Get Upgrade Unit Group Status

Get Upgrade Unit Group Status

Get upgrade status for group

Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/upgrade-unit-groups/{group-id}/status
COPY
Path Parameters
string
group-id
Required

group-id

Query Parameters
string
included_fields
Optional

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

boolean
has_errors
Optional

Flag to indicate whether to return only upgrade units with errors

integer
page_size
Optional

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

string
sort_by
Optional

Field by which records are sorted

string
cursor
Optional

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

boolean
sort_ascending
Optional

sort_ascending


Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns UpgradeUnitStatusListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineUpgradeUnitStatusListResult1
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "status": "string",
            "errors": [
                "string"
            ],
            "display_name": "string",
            "id": "string",
            "percent_complete": "number"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code