Get Upgrade Unit
Get a specific upgrade unit
Request
URI
GET
https://nsxmanager.your.domain/api/v1/upgrade/upgrade-units/{upgrade-unit-id}
COPY
Path Parameters
string
upgrade-unit-id
Required
upgrade-unit-id
Responses
200
OK
Returns UpgradeUnit of type(s) application/json
This response body class contains all of the following: Resource , InlineUpgradeUnit1
{
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"group": {
"display_name": "string",
"id": "string"
},
"warnings": [
"string"
],
"current_version": "string",
"metadata": [
{
"value": "string",
"key": "string"
}
],
"type": "string",
"id": "string",
"display_name": "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
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
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
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
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
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
Upgrade Operations
POST
Add Upgrade Units To Group Add Upgrade Units
POST
Continue Upgrade Continue
POST
Create Upgrade Unit Group
DELETE
Delete Upgrade Unit Group
POST
Fetch Upgrade Bundle From Url
GET
Get Nodes
GET
Get Nodes Summary
GET
Get Upgrade Bundle Info
GET
Get Upgrade Bundle Upload Status
GET
Get Upgrade History
GET
Get Upgrade Plan Settings
GET
Get Upgrade Status Summary
GET
Get Upgrade Summary
GET
Get Upgrade Unit
GET
Get Upgrade Unit Aggregate Info
GET
Get Upgrade Unit Group
GET
Get Upgrade Unit Group Aggregate Info
GET
Get Upgrade Unit Groups
GET
Get Upgrade Unit Groups Status
GET
Get Upgrade Unit Group Status
GET
Get Upgrade Units
GET
Get Upgrade Units Stats
GET
Get Version Whitelist
GET
Get Version Whitelist By Component
POST
Pause Upgrade Pause
POST
Reorder Upgrade Unit Group Reorder
POST
Reorder Upgrade Unit Reorder
POST
Reset Upgrade Plan Reset
POST
Start Upgrade Start
POST
Trigger Uc Upgrade Upgrade Uc
PUT
Update Upgrade Plan Settings
PUT
Update Upgrade Unit Group
PUT
Update Version Whitelist
POST
Upgrade Selected Units Upgrade Selected Units