NSX-T Data Center REST API

Return a container cluster

Returns information about a specific container cluster

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-clusters/{container-cluster-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerCluster+

ContainerCluster (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
cluster_ip_ranges	List of cluster IP range In case of Kubernetes container cluster, it specifies CIDRs that will be assigned to services created on Kubernetes.	array of IPCIDRBlock	Maximum items: 2
cluster_type	Type of the container cluster Type of the container cluster. In case of creating container cluster first time, it is expected to pass the valid cluster-type. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.	string	Enum: PAS, PKS, Kubernetes, Openshift, WCP, WCP_Guest, AKS, EKS, TKGm, TKGi, GKE, Gardener, Rancher, TAS, SupervisorCluster, WorkloadCluster, Other
cni_type	CNI type for container cluster Specifies Container Network Interface type for container cluster.	string	Enum: NCP, Antrea, Other Default: "Other"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container cluster External identifier of the container cluster.	string
infrastructure	Details of infrastructure for the container cluster Details of underlying infrastructure that hosts the container cluster. In case of creating container cluster first time, it is expected to pass the valid infrastructure. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.	ContainerInfrastructureInfo
network_errors	Network errors List of network errors related to container cluster.	array of NetworkError
network_status	Network status of container cluster Network status of container cluster.	string	Enum: HEALTHY, UNHEALTHY
node_port_local_range	Node port local range Specifies the port range to be used for NodePortLocal services.	string	Format: port-or-range
node_port_range	Node port range In case of Kubernetes container cluster, it specifies port range to be used for Kubernetes services created with the type NodePort.	string	Format: port-or-range
origin_properties	Origin properties Array of additional specific properties of container cluster in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerCluster	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
supervisor_project_id	Supervisor ContainerProject identifier for cluster Specifies supervisor container project identifier for cluster.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "external_id": "a19ad270-6026-11e9-980c-dca9048e157d", "cluster_type": "Kubernetes", "infrastructure": { "infra_type": "vSphere" }, "origin_properties": [], "resource_type": "ContainerCluster", "display_name": "cluster-1", "_last_sync_time": 1555405468523 }

NSX-T Data Center REST API

Return a container cluster

Request:

Successful Response:

ContainerCluster (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: