Get upgrade units stats

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/upgrade-units-stats

Request Headers:

n/a

Query Parameters:

UpgradeUnitsStatsRequestParameters+

Name	Description	Type	Notes
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
sync	Synchronize before returning upgrade unit stats If true, synchronize with the management plane before returning upgrade unit stats	boolean	Default: "False"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/upgrade/upgrade-units-stats?sync=false

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeUnitTypeStatsList+

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	List of upgrade unit type stats	array of UpgradeUnitTypeStats	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": { [ { "type": "HOST", "version": "1.1.1.4245555", "node_count": 10, "node_with_issues_count": 0 }, { "type": "EDGE", "version": "1.1.1.1213223", "node_count": 2, "node_with_issues_count": 0 }, { "type": "CCP", "version": "1.1.1.1433223", "node_count": 2, "node_with_issues_count": 1 }, ] } }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors:

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