Xem chi tiết cluster Kubernetes

GET/v1/clusters/{cluster_ident}

Xem chi tiết cluster Kubernetes theo ID được chỉ định.

info

Nguồn: show-details-of-a-cluster

Request

Tham số

cluster_identstringbắt buộc

UUID hoặc tên của cluster trong Magnum.

Request mẫu

Dùng 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 request

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

Response

Tham số

statusstringbắt buộc

Trạng thái hiện tại của bay/cluster.

uuidUUIDbắt buộc

UUID của cluster.

linksarraybắt buộc

Liên kết tới các tài nguyên liên quan.

stack_idUUIDbắt buộc

UUID tham chiếu của orchestration stack từ Heat orchestration service.

namestringbắt buộc

Tên của tài nguyên.

created_atstringbắt buộc

Ngày giờ tạo tài nguyên. Định dạng timestamp là ISO 8601: CCYY-MM-DDThh:mm±hh. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh (nếu có) là múi giờ lệch so với UTC. Trong ví dụ này, độ lệch là -05:00.

api_addressstringbắt buộc

URL endpoint của COE API dành cho người dùng cuối.

discovery_urlstringbắt buộc

URL discovery tuỳ chỉnh dùng cho node discovery. COE dùng URL này để phát hiện các server đã tạo nhằm chạy container. Cơ chế discovery thực tế tuỳ từng COE. Trong một số trường hợp, Magnum tự điền thông tin server vào discovery service. Nếu không chỉ định discovery_url, Magnum sẽ dùng discovery service public tại https://discovery.etcd.io. Khi đó Magnum sẽ tạo URL riêng cho từng bay và lưu thông tin server.

updated_atstringbắt buộc

Ngày giờ cập nhật tài nguyên. Nếu tài nguyên chưa từng được cập nhật, field này là null. Định dạng timestamp là ISO 8601: CCYY-MM-DDThh:mm±hh. Ví dụ: 2015-08-27T09:49:58-05:00. Giá trị ±hh (nếu có) là múi giờ lệch so với UTC. Trong ví dụ này, độ lệch là -05:00.

master_countintegerbắt buộc

Số server đóng vai trò master cho bay/cluster. Mặc định là 1. Đặt lớn hơn 1 để bật High Availability. Nếu tuỳ chọn master-lb-enabled được chỉ định trong baymodel/cluster template, các master server sẽ được đưa vào load balancer pool.

coe_versionstringbắt buộc

Thông tin phiên bản COE được chọn trong bay/cluster, giúp client chọn đúng phiên bản.

cluster_template_idUUIDbắt buộc

UUID của cluster template.

node_countintegerbắt buộc

Số server đóng vai trò node trong bay/cluster. Mặc định là 1.

keypairstringbắt buộc

Tên SSH keypair được cấu hình trên các server của bay/cluster để truy cập ssh. Bạn cần key này để ssh vào các server trong bay/cluster. Tên đăng nhập phụ thuộc vào driver của bay/cluster, ví dụ với image fedora-atomic, tên đăng nhập mặc định là fedora.

master_addressesarraybắt buộc

Danh sách floating IP của tất cả master node.

node_addressesarraybắt buộc

Danh sách floating IP của tất cả server đóng vai trò node.

status_reasonstringbắt buộc

Lý do dẫn tới trạng thái hiện tại của bay/cluster.

create_timeoutintegerbắt buộc

Thời gian timeout tạo cluster, tính bằng phút. Giá trị phải là số nguyên dương, mặc định là 60 phút. Nếu quá thời gian này trong khi tạo cluster, thao tác sẽ bị huỷ và trạng thái cluster được đặt thành CREATE_FAILED.

labelsarray

Các label tuỳ ý dưới dạng cặp key=value. Các key được chấp nhận và giá trị hợp lệ do driver của bay/cluster quy định. Label được dùng để truyền thêm tham số riêng cho từng driver.

Response mẫu

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"
}

Mã trạng thái

Thành công

Mã trạng thái	Mô tả
200 - OK	Request thành công.

Lỗi

Mã trạng thái	Mô tả
401 - Unauthorized	Cần xác thực trước khi gửi request.
403 - Forbidden	Policy không cho phép user hiện tại thực hiện thao tác này.
404 - Not Found	Không tìm thấy tài nguyên được yêu cầu.