Return aggregate information of all upgrade unit groups

Return information of all upgrade unit groups in the
upgrade plan. If request parameter summary is set to true, then
only count of upgrade units will be returned, upgrade units list
will be empty. If request parameter component type is specified,
then all upgrade unit groups for that component will be returned.

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/upgrade-unit-groups/aggregate-info

Request Headers:

n/a

Query Parameters:

UpgradeUnitGroupListRequestParameters+

Name	Description	Type	Notes
component_type	Component type based on which upgrade unit groups to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
summary	Flag indicating whether to return summary	boolean	Default: "False"
sync	Synchronize before returning upgrade unit groups If true, synchronize with the management plane before returning upgrade unit groups	boolean	Default: "False"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/aggregate-info

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeUnitGroupAggregateInfoListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of upgrade status for upgrade unit groups	array of UpgradeUnitGroupAggregateInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors:

404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable