Get a Cluster - Akua

GET

clusters

{id}

Get a Cluster

curl --request GET \
  --url https://api.akua.dev/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.akua.dev/v1/clusters/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/clusters/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/clusters/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "html_url": "<string>",
  "workspace_id": "<string>",
  "name": "shop",
  "kind": "hosted",
  "region_id": "<string>",
  "state": "provisioning",
  "capabilities": [
    "https_ingress"
  ],
  "ready_nodes": 1,
  "conditions": [
    {
      "reason": "agent-offline",
      "severity": "error",
      "message": "<string>",
      "remedy": {
        "kind": "free-capacity",
        "metric": "kaas/clusters",
        "limit": 123,
        "usage": 123,
        "hint": "<string>"
      },
      "last_transition_at": 1
    }
  ],
  "operation_id": "<string>",
  "connector": {
    "status": "pending",
    "version": "<string>",
    "last_seen_at": 1
  },
  "created_at": 1,
  "etag": "<string>",
  "storage_classes": [
    {
      "name": "local-path",
      "attachment": "node_local"
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}

Authorizations

Authorization

string

header

required

Bearer token for the authenticated caller.

Headers

akua-context

string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53

Example:

"ws_j572abc123def4"

Path Parameters

string

required

Required string length: 3 - 54

Response

The Cluster

string

required

Required string length: 3 - 54

html_url

string<uri>

required

Maximum string length: 2048

workspace_id

string

required

Required string length: 2 - 53

name

string

required

A DNS label, unique in the Workspace.

Required string length: 1 - 63

Pattern: ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$

Example:

"shop"

kind

enum<string>

required

Available options:

hosted,

attached

region_id

string | null

required

The Region of a hosted Cluster; null for an attached one.

Required string length: 3 - 54

state

enum<string>

required

provisioning: the hosted control plane starts. awaiting_node: join a server with a join token. awaiting_agent: install the agent (attached) or wait for it. configuring: the baseline is placed. disconnected: the agent stopped calling; workloads keep running.

Available options:

provisioning,

awaiting_node,

awaiting_agent,

configuring,

ready,

degraded,

disconnected,

failed,

deleting,

deleted

capabilities

enum<string>[]

required

Available options:

https_ingress,

persistent_volumes,

resource_metrics

ready_nodes

integer

required

Required range: x >= 0

conditions

object[]

required

What needs attention now; empty when nothing does. Reasons:

agent-offline (warning): the agent is not connected; workloads keep running and nothing new rolls out until it reconnects.
updater-behind (warning): the updater has run another release than the agent for 30 minutes, so no agent release is offered. Remedy run-agent-install on an attached Cluster; none on a hosted one, whose agent and updater Akua re-applies.
needs-customer-upgrade (warning): the offered agent release changes objects outside the access you granted, so it was not applied. Remedy customer-upgrade names the missing permissions and the helm upgrade command.
bundle-too-large (warning): the offered agent release is too large to deliver or to keep as a rollback copy, so it was not applied.
update-rolled-back, baseline-degraded (warning): a capability release failed its health gate and was rolled back, or a capability is not healthy; see the Cluster’s capabilities. A list shows baseline-degraded from the Cluster state only; update-rolled-back appears when the Cluster is read on its own.
When state is failed, one error whose reason says why: control-plane-unready, enrollment-expired, agent-unsupported, baseline-failed, baseline-rollback-failed, cleanup-unconfirmed, node-removal-failed or agent-bundle-failed.

Maximum array length: 32

Show child attributes

operation_id

string

required

Required string length: 2 - 192

connector

object

required

Show child attributes

created_at

integer

required

Unix timestamp (seconds)

Required range: x >= 0

etag

string

required

storage_classes

object[]

The StorageClasses Akua runs here and an Install can use, from its healthy storage capabilities. OUTPUT_ONLY. No class is the cluster default: an Install names one on every volume, the one asked for or the one Akua picks.

Show child attributes

Get a Cluster

curl --request GET \
  --url https://api.akua.dev/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.akua.dev/v1/clusters/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/clusters/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/clusters/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "html_url": "<string>",
  "workspace_id": "<string>",
  "name": "shop",
  "kind": "hosted",
  "region_id": "<string>",
  "state": "provisioning",
  "capabilities": [
    "https_ingress"
  ],
  "ready_nodes": 1,
  "conditions": [
    {
      "reason": "agent-offline",
      "severity": "error",
      "message": "<string>",
      "remedy": {
        "kind": "free-capacity",
        "metric": "kaas/clusters",
        "limit": 123,
        "usage": 123,
        "hint": "<string>"
      },
      "last_transition_at": 1
    }
  ],
  "operation_id": "<string>",
  "connector": {
    "status": "pending",
    "version": "<string>",
    "last_seen_at": 1
  },
  "created_at": 1,
  "etag": "<string>",
  "storage_classes": [
    {
      "name": "local-path",
      "attachment": "node_local"
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}