Get Cluster By Name
Get the details for a cluster.
Request
URI
GET
https://{api_host}/api/v2/clusters/{name}
COPY
Path Parameters
string
name
Required
The name of the cluster
Responses
200
cluster
Returns cluster of type(s) application/json
{
"endpoints": {
"hostname": "string",
"private_vip": "string",
"public_vip": "string"
},
"ha_enabled": false,
"ip_access_enabled": false,
"log_insight": {
"ip": "string",
"port": 0
},
"management_cluster": {
"datacenter": "string",
"datastore": "string",
"resourcepool": "string"
},
"name": "string",
"networks": [
{
"dns": [
"string"
],
"gateway": "string",
"ip_ranges": [
{
"begin_ip": "string",
"end_ip": "string"
}
],
"name": "string",
"netmask": "string",
"type": "string"
}
],
"openstack_info": {
"compute": {
"compute_clusters": [
{
"availability_zone_name": "string",
"cluster_name": "string",
"datastore_regex": "string",
"dvs_moid": "string",
"vcenter_name": "string"
}
],
"default_availability_zone_name": "string",
"passthrough": false,
"tenant_vdc": false
},
"identity": {
"admin_domain_name": "string",
"admin_password": "string",
"admin_user": "string",
"ldap_backends": [
{
"ad_domain_controllers": "string",
"ad_domain_names": "string",
"ad_site": "string",
"admin_user": "string",
"chase_referrals": false,
"group_desc_attribute": "string",
"group_filter": "string",
"group_id_attribute": "string",
"group_member_attribute": "string",
"group_members_are_ids": false,
"group_name_attribute": "string",
"group_objectclass": "string",
"group_tree_dn": "string",
"ldap_loadbalancer": false,
"name": "string",
"page_size": 0,
"password": "string",
"query_scope": "string",
"url": "string",
"use_tls": false,
"user": "string",
"user_enabled_attribute": "string",
"user_enabled_mask": 0,
"user_filter": "string",
"user_id_attribute": "string",
"user_mail_attribute": "string",
"user_name_attribute": "string",
"user_objectclass": "string",
"user_pass_attribute": "string",
"user_tree_dn": "string"
}
],
"token_expiration_time": 0
},
"image": {
"backends": [
{
"datastores": [
"string"
],
"vcenter_name": "string"
}
]
},
"network": {
"dns_designate_enabled": false,
"dvs_name": "string",
"neutron_backend": "string",
"nsx": {
"default_overlay_tz": "string",
"default_tier0_router": "string",
"default_vlan_tz": "string",
"dhcp_profile": "string",
"ens_support": false,
"insecure": false,
"metadata_proxy": "string",
"metadata_proxy_shared_secret": "string",
"native_dhcp_metadata": false,
"nsx_api_managers": "string",
"nsx_api_password": "string",
"nsx_api_user": "string"
},
"nsxv": {
"cluster_moid": "string",
"datacenter_moid": "string",
"datastore_id": "string",
"dvs_id": "string",
"external_network": "string",
"insecure": false,
"nsx_api_managers": "string",
"nsx_api_password": "string",
"nsx_api_user": "string",
"resource_pool_id": "string",
"vdn_scope_id": "string"
}
},
"volume": {
"backends": [
{
"availability_zone_name": "string",
"clusters": [
"string"
],
"driver": "string",
"vcenter_name": "string"
}
],
"default_availability_zone_name": "string"
}
},
"region_name": "string",
"topology": {
"master": {
"count": 0,
"flavor": "string"
},
"worker": {
"count": 0,
"flavor": "string"
}
},
"vcenters": [
{
"hostname": "string",
"insecure": false,
"is_management": false,
"name": "string",
"password": "string",
"username": "string"
}
],
"version": "string"
}object
attributes
Optional
Extra info about cluster.
boolean
ha_enabled
Required
The HA enabled flag.
boolean
ip_access_enabled
Required
The ip access enabled flag.
string
name
Required
The name of the cluster.
string
region_name
Required
The region name of cluster.
string
version
Required
The version of vio api.
401
Operation doesn't return any data structure
404
Operation doesn't return any data structure