NSX-T Data Center REST API

Get the container cluster status by given id

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/container-cluster/{cluster-id}/ncp/status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/systemhealth/container-cluster/49bb701-4fe9-11e9-bdc7-000c29e49f11/ncp/status

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ContainerClusterSummary+

ContainerClusterSummary (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cluster_id	Identifier of the container cluster Identifier of the container cluster.	string	Required Readonly
cluster_name	Container cluster name Display the container cluster name	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
detail	Detail information on status Detail information on status.	string	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ContainerClusterSummary	string
status	Container cluster status Display the container cluster status.	TnContainerStatusType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Container cluster type Container cluster type.	ContainerClusterType

Example Response:

{ "cluster_id": "49bb701-4fe9-11e9-bdc7-000c29e49f11", "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