compute
GET /v1/compute/clusters/{clusterId}
One cluster, with its machines and what it reports.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ sites.view หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X GET https://api.zinndigital.com/v1/compute/clusters/{clusterId} \
-H "Authorization: Bearer zdk_live_…"เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
Requires sites.view.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
clusterId (path) | Uuid | ใช่ | The cluster's id, as listComputeClusters reports it. |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
id | Uuid | ใช่ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | ใช่ | — |
deploy_target | string | ใช่ | — |
zone | string | ใช่ | — |
plan_code | string | ใช่ | — |
image | string | ใช่ | — |
worker_count | integer | ใช่ | — |
install_argocd | boolean | ใช่ | — |
deploy_sample_app | boolean | ใช่ | — |
status | string<pending, provisioning, bootstrapping, ready, failed, terminating, terminated> | ใช่ | — |
message | string | ใช่ | — |
kubernetes_version | string | ใช่ | — |
argocd_version | string | ใช่ | — |
ready_nodes | integer | ใช่ | — |
sample_app_health | string | ใช่ | Argo CD's sync/health for the sample application, e.g. Synced/Healthy. |
api_address | string | ใช่ | The Kubernetes API's public address (port 6443). |
network_id | string | ใช่ | — |
nodes | ComputeServer[] | ใช่ | — |
created_at | string | ใช่ | — |
ready_at | object | ใช่ | — |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 422 · 429 · 503