Get Upgrade Status Summary

Get upgrade status summary

Request

URI

GET

https://nsxmanager.your.domain/api/v1/upgrade/status-summary

COPY

Query Parameters

string

component_type

Optional

Component type based on which upgrade units to be filtered

string

selection_status

Optional

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

Possible values are : SELECTED, DESELECTED, ALL,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns UpgradeStatus of type(s) application/json

{
    "host_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "ccp_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "edge_status": {
        "status": "string",
        "percent_complete": "number",
        "can_skip": false,
        "details": "string",
        "component_type": "string"
    },
    "overall_upgrade_status": "string",
    "component_status": [
        {
            "status": "string",
            "percent_complete": "number",
            "can_skip": false,
            "details": "string",
            "component_type": "string"
        }
    ]
}

HostUpgradeStatus

host_status

Optional

host_status

CCPUpgradeStatus

ccp_status

Optional

ccp_status

EdgeUpgradeStatus

edge_status

Optional

edge_status

string

overall_upgrade_status

Optional

Status of upgrade

Possible values are : SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED,

array of ComponentUpgradeStatus

component_status

Optional

List of component statuses

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

Returns NotFound 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

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