Developer Documentation
Get Clusters
Released in v7.0.0.0Returns information about a specific cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Response
Response
Response BodyResponse Body
200 OK returns
ClustersInfo
of type application/json
Information about the desired state of the specified cluster.
{
"api_server_cluster_endpoint": "string",
"api_server_management_endpoint": "string",
"api_servers": [
"string"
],
"config_status": "enum",
"default_kubernetes_service_content_library": "string",
"kubernetes_status": "enum",
"kubernetes_status_messages": [
{
"severity": "enum"
}
],
"master_DNS": [
"string"
],
"master_DNS_search_domains": [
"string"
],
"messages": [
{
"severity": "enum"
}
],
"ncp_cluster_network_info": {
"cluster_distributed_switch": "string",
"default_ingress_tls_certificate": "string",
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_edge_cluster": "string",
"pod_cidrs": [
{
"address": "string",
"prefix": 0
}
]
},
"network_provider": "enum",
"service_cidr": {
"address": "string",
"prefix": 0
},
"stat_summary": {
"cpu_capacity": 0,
"cpu_used": 0,
"memory_capacity": 0,
"memory_used": 0,
"storage_capacity": 0,
"storage_used": 0
},
"tls_endpoint_certificate": "string",
"tls_management_endpoint_certificate": "string",
"worker_DNS": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| api_server_cluster_endpoint | string |
Kubernetes API Server IP address via cluster network. This is the IP address of the Kubernetes LoadBalancer type service fronting the apiservers. This endpoint is the one configured in kubeconfig after login, and used for most human and application interaction with Kubernetes. |
| api_server_management_endpoint | string |
Kubernetes API Server IP address on the management network. This is a floating IP and assigned to one of the control plane VMs on the management network. This endpoint is used by vSphere components. |
| api_servers | array of string |
Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network. |
| config_status | ClustersConfigStatus Enum |
Current setting for Clusters.ConfigStatus. |
| kubernetes_status | ClustersKubernetesStatus Enum |
Current setting for Clusters.KubernetesStatus. |
| kubernetes_status_messages | array of ClustersMessage |
Current set of messages associated with the object. |
| messages | array of ClustersMessage |
Current set of messages associated with the object. |
| network_provider | ClustersNetworkProvider Enum |
The provider of cluster networking for this vSphere Namespaces cluster. |
| service_cidr | NamespaceManagementIpv4Cidr |
CIDR block from which Kubernetes allocates service cluster IP addresses. |
| stat_summary | ClustersStats |
Basic runtime statistics for the cluster. |
| default_kubernetes_service_content_library | string |
Identifier of the Content Library which holds the VM Images for vSphere Kubernetes Service. This Content Library should be subscribed to VMware’s hosted vSphere Kubernetes Service Repository. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library. |
| master_DNS | array of string |
List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. |
| master_DNS_search_domains | array of string |
List of domains (for example “vmware.com”) to be searched when trying to lookup a host name on Kubernetes API server, specified in order of preference. |
| ncp_cluster_network_info | ClustersNCPClusterNetworkInfo |
Specification for the NSX Container Plugin cluster network. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is NSXT_CONTAINER_PLUGIN. |
| tls_endpoint_certificate | string |
PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed via the load balancer, e.g. devops user on corporate network. This certificate is only valid for use with the apiServerClusterEndpoint. |
| tls_management_endpoint_certificate | string |
PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed from the management network, e.g. from ESX servers or VCSA. This certificate is only valid for use with the apiServerManagementEndpoint. |
| worker_DNS | array of string |
List of DNS server IP addresses to use for pods that execute on the worker nodes (which are native pods on ESXi hosts in the vSphere Namespaces Supervisor). |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : if cluster could not be located. | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. |
| 405 | Error | com.vmware.vapi.std.errors.unsupported : if the specified cluster does not have vSphere Namespaces enabled. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege. |
On This Page
Clusters Operations
get
get
put
patch
post
post
