more than half documented
Get Clusters
DescriptionReturns information about a specific cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementClustersInfo of type application/json
Information about the desired state of the specified cluster.
{
"Master_DNS_names": [
"string"
],
"api_server_cluster_endpoint": "string",
"api_server_management_endpoint": "string",
"api_servers": [
"string"
],
"config_status": "enum",
"default_image_registry": {
"hostname": "string",
"port": 0
},
"default_image_repository": "string",
"default_kubernetes_service_content_library": "string",
"ephemeral_storage_policy": "string",
"image_storage": {
"storage_policy": "string"
},
"kubernetes_status": "enum",
"kubernetes_status_messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "enum"
}
],
"load_balancers": [
{
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"avi_info": {
"certificate_authority_chain": "string",
"server": {
"host": "string",
"port": 0
},
"username": "string"
},
"ha_proxy_info": {
"certificate_authority_chain": "string",
"servers": [
{
"host": "string",
"port": 0
}
],
"username": "string"
},
"id": "string",
"provider": "enum"
}
],
"login_banner": "string",
"master_DNS": [
"string"
],
"master_DNS_search_domains": [
"string"
],
"master_NTP_servers": [
"string"
],
"master_management_network": {
"address_range": {
"address_count": 0,
"gateway": "string",
"starting_address": "string",
"subnet_mask": "string"
},
"floating_IP": "string",
"mode": "enum",
"network": "string"
},
"master_storage_policy": "string",
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"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
},
"size_hint": "enum",
"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"
],
"workload_networks": {
"network_list": [
{
"network": "string",
"network_provider": "enum",
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"portgroup": "string",
"subnet_mask": "string"
}
}
],
"supervisor_primary_workload_network": {
"network": "string",
"network_provider": "enum",
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"portgroup": "string",
"subnet_mask": "string"
}
}
},
"workload_ntp_servers": [
"string"
]
}
kubernetes_status
Required
Current setting for Clusters.KubernetesStatus.
Possible values are: READY , WARNING , ERROR
string
api_server_cluster_endpoint
Required
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.
string
api_server_management_endpoint
Required
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.
array of
string
api_servers
Required
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
Required
Current setting for Clusters.ConfigStatus.
Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR
service_cidr
Required
CIDR block from which Kubernetes allocates service cluster IP addresses.
network_provider
Required
The provider of cluster networking for this vSphere Namespaces cluster.
Possible values are: NSXT_CONTAINER_PLUGIN , VSPHERE_NETWORK
array of
NamespaceManagementClustersMessage
messages
Required
Current set of messages associated with the object.
array of
NamespaceManagementClustersMessage
kubernetes_status_messages
Required
Current set of messages associated with the object.
array of
string
Master_DNS_names
Optional
List of additional DNS names to associate with the Kubernetes API server. These DNS names are embedded in the TLS certificate presented by the API server. If unset, no additional DNS names are embedded in the TLS certificate.
image_storage
Optional
Specification for storage to be used for container images. This field is optional because it was added in a newer version than its parent node.
array of
NamespaceManagementLoadBalancersInfo
load_balancers
Optional
Information related to the Load balancer used for provisioning virtual servers in the namespace. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.
string
login_banner
Optional
Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, just skip it.
array of
string
master_DNS
Optional
List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.
array of
string
master_DNS_search_domains
Optional
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.
array of
string
master_NTP_servers
Optional
List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. If unset, VMware Tools based time synchronization is enabled.
master_management_network
Optional
Specification for the management network on Kubernetes API server. This field is optional because it was added in a newer version than its parent node.
string
master_storage_policy
Optional
Identifier of storage policy associated with Kubernetes API server. This field is optional because it was added in a newer version than its parent node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.
string
ephemeral_storage_policy
Optional
Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. This field is optional because it was added in a newer version than its parent node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.
ncp_cluster_network_info
Optional
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.
string
default_kubernetes_service_content_library
Optional
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.
string
default_image_repository
Optional
Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, defaults to Docker Hub official repository in case of Docker Hub image registry, otherwise defaults to empty string.
size_hint
Optional
Current setting for SizingHint. This affects the size and resources allocated to the Kubernetes API server. This field is optional because it was added in a newer version than its parent node.
Possible values are: TINY , SMALL , MEDIUM , LARGE
default_image_registry
Optional
Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, defaults to Docker Hub.
string
tls_endpoint_certificate
Optional
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.
string
tls_management_endpoint_certificate
Optional
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.
array of
string
worker_DNS
Optional
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).
workload_networks
Optional
Information about workload networks associated with the cluster. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.
array of
string
workload_ntp_servers
Optional
Information about NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. This field is optional because it was added in a newer version than its parent node.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}
Errors
400
com.vmware.vapi.std.errors.unsupported : if the specified cluster does not have vSphere Namespaces enabled.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
put
patch
get
post
post
