JSON mit JQ auf der Bash nutzen (Hetzner Cloud)

2 Jun 2020 - Lesezeit: 5 Minuten

JSON ist der neue heisse shice auf allen erdenklichen Plattformen. Alle APIs die ich kenne und aktuell entwickelt werden geben ihren Senf als JSON dazu. JSON bedeutet JavaScript Object Notation und ist, nach den anfänglichen Bauchschmerzen die man hat weil JavaScript im Namen vorkommt, tatsächlich gar nicht soooo schlimm wie man es zuächst vermutet.

Natürlich darf man nun keine schicke XML erwarten, die man auch als Nachtlektüre lesen könnte. Vielmehr ist es mehrschichtig aufgebaut und man arbeitet sich so durch Arrays und Objekte durch, bis man an der Stelle ist die einen interessiert.

Das gute an der aktuellen Bewegung ist eigentlich, dass es überall nun APIs gibt, so kann man seinen kram endlich strukturiert weg skripten. Zwar hat das paar Jahrzehnte gedauert - aber mich hat ja auch keiner gefragt.

Wie dem auch sei: JSON ist gan passabel mittels JQ auf der Bash zu nutzen. Doch wie fängt man an?

1. Hol dir nen API Key

Das muss man bei seinem Provider nachschauen wie das geht. In meinem Fall habe ich einfach mal bei HetznerCloud geschaut und bekomme ihn einfach, wenn in innerhalb meines Projekts auf Zugänge gehe und mir dort einen Key erstelle.

2. Hol dir die API Dokumentation

Natürlich macht auch bei einer API jeder was er für richtig hält. In Sofern ist es gar nicht so schlecht, wenn man sich in der Dokumentation bewegen kann.

3. Sprich mit der API

Das ist der Teil, der wahrlich am einfachsten und am angenehmsten ist. Dazu nutzt man schlicht einen curl oneliner:

API_TOKEN=HIERISTDERUNTER1GEHOLTEAPITOKENSUPERDUPERKEYDRIN
curl -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions'

Schon bekommen wir Informationen von der API und können schauen was sie uns zu bieten hat. JSON ist in der Regel aber nicht cool formatiert - s jagen wir es zunächst durch JQ, damit es etwas schicker wird:

curl --silent  -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq '.'

4. Schau dich um

Was genau kann man mit dem Wust an Zeilen und Zeichen nun machen? Am eifnachsten schaut man sich um, indem man sich einen Überblick verschafft, was da eigentlich grade ankommt. Das geht mit dem Kommando keys

curl --silent -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq 'keys'
[
  "actions",
  "meta"
]

Damit kennen wir die oberste Ebene. Nun sollten wir vielleicht herausfinden ob es sich bei den Elementen um ein Objekt oder ein Array handelt. Dafür geben wir das erste Mal etwas nach dem Punkt an. Nämlich ein Teil der Ausgabe das wir uns anschauen wollen:

curl --silent -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq '.actions | type'
"array"

Wir sehen also, das actions ein Array ist. Das könnten wir der Reihe nach durchgehen, wenn wir wüssten wie lang es ist. Das finden wir schnell heraus, bevor es weiter geht

curl --silent -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq '.actions | length'
25

Soso, 25 Einträge hat das Array actions also. Wenn wir jetzt schauen wollen welche Objekte einen bestimmten Wert haben, so können wir hier einfach select benutzen.

curl --silent -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq '.actions[] | select(.command=="attach_to_network")

Damit bekommen wir dann alles zu sehen. Wenn uns aber nur die ID interessiert, dann können wir das gewünschte Feld einfach filtern, indem wir es hinten dran hängen

curl --silent -H "Authorization: Bearer $API_TOKEN" 'https://api.hetzner.cloud/v1/actions' | jq '.actions[] | select(.command=="attach_to_network") | .id'

Quellen und Links

Es wurden noch keine Kommentare verfasst, sei der erste!

Über

Ich bin manisch interessiert am Leben. An den Dingen die wir tun können und den Optionen die sich uns bieten. IT, Netzwerke und EDV im allgemeinen sind mein Steckenpferd: ich mache das einfach zu gern und bin gut darin zu kombinieren. Fotografie, Hunde, Jagd, Falknerei ist das, was mich vollständig macht. All diese Dinge gehören zu meinem Leben und ich genieße jeden Tag.