NSX-T Data Center REST API

Read health metrics of edge cluster (Experimental)

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth-extended/edge-cluster

Request Headers:

n/a

Query Parameters:

EdgeClusterHealthParameters+

EdgeClusterHealthParameters (schema)

Name	Description	Type	Notes
cluster_id	The UUID of Edge cluster This parameter is to filter the specific Edge cluster. If not provide any cluster_id, it means query all Edge cluster.	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 Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	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	If true, results are sorted in ascending order	boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/systemhealth-extended/edge-cluster

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EdgeClusterMetricsList+

EdgeClusterMetricsList (schema)

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 health metrics List of Edge cluster health metrics.	array of EdgeClusterMetric
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:

cluster_management

Additional Errors:

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