Show Kubernetes Cluster Details

GET/v1/clusters/{cluster_ident}

Show details of a Kubernetes cluster with the specified ID.

info

Source: show-details-of-a-cluster

Request

Request Parameters

cluster_identstringrequired

The UUID or name of clusters in Magnum.

Sample Request

cURL

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<..>' \
https://api.vietnix.cloud:9513/v1/clusters/ed495c33-601c-4f5c-86c8-d7c13b5f6b0e

HTTP

GET https://api.vietnix.cloud:9513/v1/clusters/ed495c33-601c-4f5c-86c8-d7c13b5f6b0e
Content-Type: application/json
X-Auth-Token: gAAAAA<..>

Response

Response Parameters

statusstringrequired

The current state of the bay/cluster.

uuidUUIDrequired

The UUID of the cluster.

linksarrayrequired

Links to the resources in question.

stack_idUUIDrequired

The reference UUID of orchestration stack from Heat orchestration service.

namestringrequired

Name of the resource.

created_atstringrequired

The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm±hh. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC. In this example, the offset value is -05:00.

api_addressstringrequired

The endpoint URL of COE API exposed to end users.

discovery_urlstringrequired

The custom discovery URL for node discovery. This is used by the COE to discover the servers that have been created to host the containers. The actual discovery mechanism varies with the COE. In some cases, Magnum fills in the server info in the discovery service. In other cases, if the discovery_url is not specified, Magnum will use the public discovery service at: https://discovery.etcd.io. In this case, Magnum will generate a unique URL here for each bay and store the info for the servers.

updated_atstringrequired

The date and time when the resource was updated. If the resource has not been updated, this field will be null. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm±hh. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC. In this example, the offset value is -05:00.

master_countintegerrequired

The number of servers that will serve as master for the bay/cluster. The default is 1. Set to more than 1 master to enable High Availability. If the option master-lb-enabled is specified in the baymodel/cluster template, the master servers will be placed in a load balancer pool.

coe_versionstringrequired

Version info of chosen COE in bay/cluster for helping client in picking the right version of client.

cluster_template_idUUIDrequired

The UUID of the cluster template.

node_countintegerrequired

The number of servers that will serve as node in the bay/cluster. The default is 1.

keypairstringrequired

The name of the SSH keypair to configure in the bay/cluster servers for ssh access. Users will need the key to be able to ssh to the servers in the bay/cluster. The login name is specific to the bay/cluster driver, for example with fedora-atomic image, default login name is fedora.

master_addressesarrayrequired

List of floating IP of all master nodes.

node_addressesarrayrequired

List of floating IP of all servers that serve as node.

status_reasonstringrequired

The reason of bay/cluster current status.

create_timeoutintegerrequired

The timeout for cluster creation in minutes. The value expected is a positive integer and the default is 60 minutes. If the timeout is reached during cluster creation process, the operation will be aborted and the cluster status will be set to CREATE_FAILED.

labelsarray

Arbitrary labels in the form of key=value pairs. The accepted keys and valid values are defined in the bay/cluster drivers. They are used as a way to pass additional parameters that are specific to a bay/cluster driver.

Sample Response

Response body

{
    "uuid": "ed495c33-601c-4f5c-86c8-d7c13b5f6b0e",
    "name": "kubApi_template",
    "cluster_template_id": "389ecf86-46ce-4cdd-b7f3-889b0603b7ed",
    "keypair": "Docs Writter",
    "node_count": 1,
    "master_count": 1,
    "docker_volume_size": 10,
    "labels": {
        "boot_volume_type": "nvmer3",
        "docker_volume_type": "nvmer3",
        "boot_volume_size": "20",
        "etcd_lb_disabled": "true",
        "heat_container_agent_tag": "5.3.11",
        "cloud_provider_tag": "v1.31.1",
        "cloud_provider_enabled": "true",
        "cinder_csi_plugin_tag": "v1.31.1",
        "csi_snapshotter_tag": "v8.0.1",
        "csi_attacher_tag": "v4.6.1",
        "flannel_tag": "v0.11.0-amd64",
        "cinder_csi_enabled": "true",
        "availability_zone": "nova",
        "use_podman": "true",
        "etcd_tag": "v3.5.13",
        "cgroup_driver": "systemd",
        "octavia_api_lb_flavor": "",
        "octavia_default_flavor": "",
        "auto_scaling_enabled": "True",
        "cluster_upgrade_method": "replace",
        "network_driver": "cilium",
        "kube_tag": "v1.31.2",
        "kube_version": "v1.31.2",
        "hyperkube_image": "docker.io/virtuozzo/hci-binary-hyperkube",
        "autoscaler_tag": "1.31.0",
        "coredns_tag": "1.11.3",
        "k8s_keystone_auth_tag": "v1.31.1",
        "cilium_tag": "v1.16.3",
        "container_runtime": "containerd",
        "monitoring_enabled": "False",
        "minion_floating_ip_disabled": "True",
        "cilium_routing_mode": "native"
    },
    "master_flavor_id": "medium.2c.4g",
    "flavor_id": "small.1c.2g",
    "create_timeout": 60,
    "links": [
        {
            "href": "https://api.vietnix.cloud:9513/v1/clusters/ed495c33-601c-4f5c-86c8-d7c13b5f6b0e",
            "rel": "self"
        },
        {
            "href": "https://api.vietnix.cloud:9513/clusters/ed495c33-601c-4f5c-86c8-d7c13b5f6b0e",
            "rel": "bookmark"
        }
    ],
    "stack_id": "f62925a9-886c-467e-876f-d9752f8042d4",
    "status": "CREATE_COMPLETE",
    "status_reason": null,
    "health_status": "HEALTHY",
    "health_status_reason": {
        "kubapi-template-tz74qn72eydi-master-0.Ready": "True",
        "kubapi-template-tz74qn72eydi-node-0.Ready": "True",
        "api": "ok"
    },
    "discovery_url": null,
    "api_address": "https://45.115.16.165:6443",
    "coe_version": "v1.31.2",
    "container_version": "1.12.6",
    "project_id": "f33507157a634f1cac71e06a70fb558e",
    "user_id": "64166c7effeb4a89b59c073588099640",
    "node_addresses": [
        "192.168.0.28"
    ],
    "master_addresses": [
        "45.115.16.165"
    ],
    "fixed_network": "87aa2b20-580c-420c-9ca0-15f20144024b",
    "fixed_subnet": "916164bc-66cb-4f99-8f41-2e13ad898b15",
    "floating_ip_enabled": true,
    "merge_labels": false,
    "labels_overridden": {},
    "labels_added": {
        "boot_volume_type": "nvmer3",
        "docker_volume_type": "nvmer3",
        "boot_volume_size": "20",
        "etcd_lb_disabled": "true",
        "heat_container_agent_tag": "5.3.11",
        "cloud_provider_tag": "v1.31.1",
        "cloud_provider_enabled": "true",
        "cinder_csi_plugin_tag": "v1.31.1",
        "csi_snapshotter_tag": "v8.0.1",
        "csi_attacher_tag": "v4.6.1",
        "flannel_tag": "v0.11.0-amd64",
        "cinder_csi_enabled": "true",
        "availability_zone": "nova",
        "use_podman": "true",
        "etcd_tag": "v3.5.13",
        "cgroup_driver": "systemd",
        "octavia_api_lb_flavor": "",
        "octavia_default_flavor": "",
        "auto_scaling_enabled": "True",
        "cluster_upgrade_method": "replace",
        "network_driver": "cilium",
        "kube_tag": "v1.31.2",
        "kube_version": "v1.31.2",
        "hyperkube_image": "docker.io/virtuozzo/hci-binary-hyperkube",
        "autoscaler_tag": "1.31.0",
        "coredns_tag": "1.11.3",
        "k8s_keystone_auth_tag": "v1.31.1",
        "cilium_tag": "v1.16.3",
        "container_runtime": "containerd",
        "monitoring_enabled": "False",
        "minion_floating_ip_disabled": "True",
        "cilium_routing_mode": "native"
    },
    "labels_skipped": {},
    "master_lb_enabled": false,
    "template_delete_on_termination": false,
    "nodegroups": [
        {
            "uuid": "53caa5c3-78d8-4bf1-b8a3-8a5b9d7b0cdd",
            "name": "default-worker",
            "flavor_id": "small.1c.2g",
            "image_id": "d275727a-a1c9-4d71-8180-adadc7fc266b",
            "node_count": 1,
            "role": "worker",
            "min_node_count": 0,
            "max_node_count": null,
            "is_default": true,
            "stack_id": "f62925a9-886c-467e-876f-d9752f8042d4",
            "status": "CREATE_COMPLETE",
            "merge_labels": false,
            "server_group_id": "fa43243f-3437-4b87-9f85-2e4f77c08faa",
            "nodes": {
                "0": "9e2a2ade-0753-4167-af22-2996a16130b8"
            },
            "coe_version": "v1.31.2"
        },
        {
            "uuid": "481387ce-b25c-4336-b5d0-23f889906ed0",
            "name": "default-master",
            "flavor_id": "medium.2c.4g",
            "image_id": "d275727a-a1c9-4d71-8180-adadc7fc266b",
            "node_count": 1,
            "role": "master",
            "min_node_count": 0,
            "max_node_count": null,
            "is_default": true,
            "stack_id": "f62925a9-886c-467e-876f-d9752f8042d4",
            "status": "CREATE_COMPLETE",
            "merge_labels": false,
            "server_group_id": "63c7d4a9-6368-4fda-95ef-ac26aa89f715",
            "nodes": {
                "0": "b18fa31e-2de6-4f20-a356-636d40570e3e"
            },
            "coe_version": "v1.31.2"
        }
    ],
    "created_at": "2025-09-25T03:27:38.922978+00:00",
    "updated_at": "2025-09-25T03:31:20.035394+00:00"
}

Status Code

Success

Status Code	Description
200 - OK	Request was successful.

Error

Status Code	Description
401 - Unauthorized	User must authenticate before making a request.
403 - Forbidden	Policy does not allow current user to do this operation.
404 - Not Found	The requested resource could not be found.