Chuyển tới nội dung chính

Liệt kê cluster Kubernetes

GET/v1/clusters

Liệt kê tất cả cluster Kubernetes.

info

Request​

Request mẫu​

Dùng curl​

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAAB<...>' \
https://api.vietnix.cloud:9513/v1/clusters

HTTP request​

GET https://api.vietnix.cloud:9513/v1/clusters
Content-Type: application/json
X-Auth-Token: gAAAAAB<...>

Response​

Tham số​

clustersarraybắt buộc

Danh sách tất cả cluster trong Magnum.

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.

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.

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.

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.

Response mẫu​

Response body
{
"clusters": [
{
"uuid": "9bd6af9b-d0dd-4083-804e-bfafc3fbd5db",
"name": "kub01",
"cluster_template_id": "6bde0752-643f-46b0-be7e-4fc97573d6c0",
"keypair": "Docs Writter",
"node_count": 1,
"master_count": 1,
"docker_volume_size": 10,
"labels": {
"etcd_lb_disabled": "true",
"heat_container_agent_tag": "5.3.11",
"boot_volume_size": "20",
"boot_volume_type": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
"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",
"docker_volume_type": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
"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/9bd6af9b-d0dd-4083-804e-bfafc3fbd5db",
"rel": "self"
},
{
"href": "https://api.vietnix.cloud:9513/clusters/9bd6af9b-d0dd-4083-804e-bfafc3fbd5db",
"rel": "bookmark"
}
],
"stack_id": "652ec709-7c1f-4cbe-b925-cad8de90e706",
"status": "CREATE_COMPLETE",
"health_status": "HEALTHY",
"merge_labels": false,
"template_delete_on_termination": false,
"nodegroups": [
{
"uuid": "c7c82b3b-c0ed-4540-a0b1-90af9d9deaba",
"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": "652ec709-7c1f-4cbe-b925-cad8de90e706",
"status": "CREATE_COMPLETE",
"merge_labels": false,
"server_group_id": "1504f1ba-b0e3-4824-b976-60b2fa2bfe79",
"nodes": {
"0": "2ededa48-21ff-4049-acdc-a3dd5791946d"
},
"coe_version": "v1.31.2"
},
{
"uuid": "fd769417-6a19-4705-aa5d-8d59e56faaf6",
"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": "652ec709-7c1f-4cbe-b925-cad8de90e706",
"status": "CREATE_COMPLETE",
"merge_labels": false,
"server_group_id": "c6d7f95b-d675-41d4-bed4-61a5981855c3",
"nodes": {
"0": "815d7d9b-758e-4a24-9896-8bdcba1a448c"
},
"coe_version": "v1.31.2"
}
]
}
]
}

Mã trạng thái​

Thành công​

Mã trạng tháiMô tả
200 - OKRequest thành công.

Lỗi​

Mã trạng tháiMô tả
401 - UnauthorizedCần xác thực trước khi gửi request.
403 - ForbiddenPolicy không cho phép user hiện tại thực hiện thao tác này.