NSX-T Data Center REST API

Get all the container cluster status

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/container-cluster/ncp/status

Request Headers:

n/a

Query Parameters:

ContainerClusterListRequestParameters+

ContainerClusterListRequestParameters (schema)

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 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		boolean
sort_by	Field by which records are sorted	string
status	Container cluster status	TnContainerStatusType

Request Body:

n/a

Example Request:

GET https: //<nsx-mgr>/api/v1/systemhealth/container-cluster/ncp/status

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ContainerClusterStatusList+

ContainerClusterStatusList (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	Container cluster list Container cluster list.	array of ContainerClusterSummary	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" : [ "cluster_id": "49bb701-4fe9-11e9-bdc7-000c29e49f11", "cluster_name": "PKS-Cluster-1", "type": "PKS", "status": "HEALTHY", "detail":"" }, { "cluster_id": "b8b0889f-338c-5c65-98bd-a5642ae2aa00", "cluster_name": "PKS-Cluster-2", "type": "PKS", "status": "HEALTHY", "detail":"", "interval": 180 } ] }

Required Permissions:

read

Feature:

tools_system_health_agent

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