OpenapiVisor
Returns one cluster's detail: node pools + worker nodes.
Returns one cluster's detail: node pools + worker nodes.
GET /v1/visor/k8s/clusters/{id}
| Address | https://api.hanzo.ai/v1/visor/k8s/clusters/{id} |
| Method | GET |
| Operation | getKubernetesCluster |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one cluster's detail: node pools + worker nodes. Visor scopes the lookup to the org (a foreign or missing id resolves to not-found), so a tenant can never read another tenant's cluster by guessing an id.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the provider's DOKS cluster id. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | clusterDetailView | ok |
200 body — 34 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
amdGpu | body | integer | — | |
createdAt | body | string | — | |
doClusterId | body | string | — | |
doksClusterId | body | string | — | |
kind | body | string | — | |
name | body | string | — | |
nodeCount | body | integer | — | |
nodePools | body | nodePoolView[] | — | |
nodePools[].autoScale | body | boolean | — | AutoScale reports whether the provider's cluster autoscaler owns this pool's size, moving Count between MinNodes and MaxNodes as workloads demand. |
nodePools[].count | body | integer | — | Count is how many nodes the pool has right now. |
nodePools[].maxNodes | body | integer | — | MaxNodes is the ceiling the autoscaler will not grow the pool past, and so the bound on what this pool can cost. |
nodePools[].minNodes | body | integer | — | MinNodes is the floor the autoscaler will not shrink the pool below. |
nodePools[].name | body | string | — | Name is the pool's name as the provider knows it. |
nodePools[].poolId | body | string | — | PoolID is the provider's id for the pool — the value the scale and delete routes address it by. |
nodePools[].size | body | string | — | Size is the provider size slug every node in the pool runs at ("s-4vcpu-8gb", "gpu-h100x8-640gb"). |
nodeSize | body | string | — | |
nodes | body | machineView[] | — | Nodes is every worker node in the cluster, each in the same shape the machines surface uses — a node IS a machine, addressable by its own id. |
nodes[].createdTime | body | string | — | CreatedTime is when the machine came into being: the provider's own creation timestamp for a Visor machine, passed through in whatever form it states it, and… |
nodes[].gpu | body | string | — | GPU names the accelerators this machine holds ("H100", or "2× NVIDIA GB10" for a BYO machine reporting a matched pair). |
nodes[].id | body | string | — | ID addresses this machine on the /v1/visor/machines/:id routes: the org-scoped NAME Visor keys a machine by, falling back to the provider id for a machine that… |
nodes[].image | body | string | — | Image is the OS image the machine booted from, as the provider names it. |
nodes[].mem | body | string | — | Mem is system RAM rendered for a human ("8 GB"), not a number to compute with. |
nodes[].name | body | string | — | Name is the label to show a human — Visor's displayName, or the machine name when it carries none. A BYO machine's is its hostname. |
nodes[].os | body | string | — | Os is the operating system on the machine — Visor's record for a provisioned one, the host's own report (linux, darwin, windows) for a BYO one. |
nodes[].privateIp | body | string | — | PrivateIp is the address on the provider's own network, reachable from the org's other machines in the same region. |
nodes[].provider | body | string | — | Provider is the cloud that runs the machine ("digitalocean"), or "byo" for one the operator dialed in with hanzo link. |
nodes[].publicIp | body | string | — | PublicIp is the internet-facing address the provider assigned. |
nodes[].region | body | string | — | Region is the provider region slug ("sfo3"), or the zone when the provider reports only that. |
nodes[].status | body | string | — | Status is the lifecycle state in the PROVIDER's own words ("active", "running", "off"), passed through rather than mapped onto a vocabulary of ours. |
nodes[].type | body | string | — | Type is the provider SIZE SLUG the machine runs at ("s-2vcpu-4gb", "gpu-h100x8-640gb") — the value a launch asks for, and what Vcpu/Mem/GPU are read out of… |
nodes[].vcpu | body | integer | — | Vcpu is logical cores — the provider's own cpuSize when that is a clean integer, else the count read out of the size slug (4 from "s-4vcpu-8gb"). |
nvidiaGpu | body | integer | — | |
region | body | string | — | |
status | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, VisorApi } from 'hanzoai';
const api = new VisorApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getKubernetesCluster({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import VisorApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = VisorApi(client).get_kubernetes_cluster(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.VisorAPI.GetKubernetesCluster(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, visor_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = visor_api::get_kubernetes_cluster(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.VisorApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new VisorApi(client).getKubernetesCluster();curl https://api.hanzo.ai/v1/visor/k8s/clusters/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"Tool visor, op getKubernetesCluster — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "visor",
"arguments": {
"op": "getKubernetesCluster",
"input": {
"id": "<id>"
}
}
}
}'How is this guide?