Go-SDK: Anwendungen verwalten

Jede Methode auf dieser Seite befindet sich unter c.Apps und nimmt zuerst ctx, dann die App-ID. Eine appID kann auch die zusammengesetzte Form <appId>-<workspaceId> einer App sein, die über einen Workspace geteilt wird. Jedes Snippet unten läuft für sich allein in diesem Programm: Füge jeweils eines in main ein und führe goimports aus (siehe Beispiele ausführen).

package main

import (
	"context"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

var (
	ctx   = context.Background()
	c     = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID = "abc123def456abc123def456"
)

func main() {
	// Paste one snippet here, then run goimports.
}

Um deine Apps aufzulisten, verwende c.Account.Me: Sein Slice Applications enthält jede App, die der Schlüssel sehen kann.

Eine Anwendung abrufen

app, err := c.Apps.Get(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(app.ID, app.Name, app.Language, app.RAM, app.Cluster, app.CreatedAt)

Feld	Typ	Beschreibung
`ID` (`id`)	`string`	App-ID
`Name` (`name`)	`string`	Anzeigename
`Description` (`desc`)	`string`	Beschreibung, `""`, wenn nicht gesetzt
`Owner` (`owner`)	`string`	Benutzer-ID des Eigentümers
`Cluster` (`cluster`)	`string`	Cluster, auf dem die App läuft
`RAM` (`ram`)	`int`	Zugewiesener RAM in MB
`Language` (`language`)	`string`	Sprache der Runtime
`Domain` (`domain`)	`*string`	Standard-Host `<subdomain>.squareweb.app`; `nil` bei Nicht-Web-Apps
`Custom` (`custom`)	`*string`	Eigene Domain; `nil`, wenn keine gesetzt ist
`CreatedAt` (`created_at`)	`time.Time`	Erstellungsdatum

Status

Status(ctx, appID) gibt den aktuellen Zustand mit formatierten Werten zurück:

status, err := c.Apps.Status(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(status.Status)  // e.g. "running", "exited"
fmt.Println(status.Running) // true
fmt.Println(status.CPU)     // "0.5%"
fmt.Println(status.RAM)     // "120.4MB" (RAM in use)
fmt.Println(status.Storage, status.Network.Total, status.Network.Now)
if status.Uptime != nil {
	fmt.Println(*status.Uptime) // Unix ms of the last start; nil when stopped
}

StatusRaw(ctx, appID) gibt stattdessen Zahlen zurück (CPU in %, RAM in MB, Storage in Bytes, Network.Total und Network.Now als Bytepaare [in, out]):

raw, err := c.Apps.StatusRaw(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(raw.CPU, raw.RAM, raw.Network.Total) // 0.5 120.4 [1024 2048]

Uptime ist ein Zeitstempel (wann die App gestartet wurde), keine Dauer. Verwende time.Since(time.UnixMilli(*status.Uptime)) für die Laufzeit seit dem Start.

Status aller Anwendungen

StatusAll(ctx, workspaceID) gibt in einer einzigen Anfrage eine Zusammenfassung pro App zurück, die der Schlüssel sehen kann. Übergib "" für alle Apps oder eine Workspace-ID nur für die Apps dieses Workspace. CPU und RAM sind nur gesetzt (nicht ""), solange die App läuft.

items, err := c.Apps.StatusAll(ctx, "")
if err != nil {
	log.Fatal(err)
}
for _, it := range items {
	if it.Running {
		fmt.Println(it.ID, it.CPU, it.RAM)
	} else {
		fmt.Println(it.ID, "stopped")
	}
}

Starten, Stoppen und Neustarten

if err := c.Apps.Start(ctx, appID); err != nil {
	log.Fatal(err)
}
if err := c.Apps.Stop(ctx, appID); err != nil {
	log.Fatal(err)
}
if err := c.Apps.Restart(ctx, appID); err != nil {
	log.Fatal(err)
}

Der Server hält diese Aufrufe offen, bis der Container reagiert, daher warten sie ohne Deadline auf ctx mindestens 2 Minuten, bevor ein Timeout eintritt. Lehnt die Plattform die Aktion ab, gibt der Aufruf einen *APIError mit Status 409, einem Code und einer leeren Message zurück:

Code	Bedeutung
`CONTAINER_ALREADY_STARTED`	`start` auf einer laufenden App
`CONTAINER_ALREADY_STOPPED`	`stop` auf einer gestoppten App
`CONTAINER_TEMPORARILY_SUSPENDED`	Die App ist gesperrt
`CONTAINER_NOT_FOUND`	Der Container existiert nicht auf dem Cluster
`CONTAINER_INSUFFICIENT_DISK_SPACE`	Nicht genug Speicherplatz zum Starten
`CONTAINER_NETWORK_CONFLICT`	Netzwerkkonflikt auf dem Cluster
`ACTION_FAILED`	Der Cluster konnte die Aktion nicht ausführen

„Bereits gestartet“ und „bereits gestoppt“ sind ebenfalls Fehler. Wenn sie für dich einen Erfolg bedeuten, behandle sie:

err := c.Apps.Start(ctx, appID)

var apiErr *squarecloud.APIError
if err != nil && !(errors.As(err, &apiErr) && apiErr.Code == squarecloud.CodeContainerAlreadyStarted) {
	log.Fatal(err)
}

Logs

Logs(ctx, appID) gibt die neueste Konsolenausgabe als einen String zurück ("", wenn es keine gibt).

logs, err := c.Apps.Logs(ctx, appID)
if err != nil {
	log.Fatal(err)
}
fmt.Println(logs)

Für einen Live-Stream der Logs verwende Realtime.

Metriken

Metrics(ctx, appID) gibt die letzten 24 Stunden zurück, einen Punkt alle 5 Minuten, der neueste zuerst.

points, err := c.Apps.Metrics(ctx, appID)
if err != nil {
	log.Fatal(err)
}
if len(points) > 0 {
	latest := points[0]
	fmt.Println(latest.Date, latest.CPU, latest.RAM, latest.Net)
}

Domains und Load Balancer

Domains(ctx) listet die Standard- und eigenen Hostnamen aller Apps auf. LoadBalancers(ctx) listet die Domains, die sich mehrere Apps teilen, zusammen mit dem Limit deines Plans.

domains, err := c.Apps.Domains(ctx)
if err != nil {
	log.Fatal(err)
}
for _, d := range domains {
	fmt.Println(d.AppID, d.Hostname, d.Type) // Type: "subdomain" | "custom"
}

lb, err := c.Apps.LoadBalancers(ctx)
if err != nil {
	log.Fatal(err)
}
fmt.Println(lb.Limit)
for _, balancer := range lb.Balancers {
	ids := make([]string, 0, len(balancer.Apps))
	for _, app := range balancer.Apps {
		ids = append(ids, app.ID)
	}
	fmt.Println(balancer.Hostname, ids)
}

Um eine eigene Domain festzulegen, siehe Netzwerk.

Eine Anwendung löschen

if err := c.Apps.Delete(ctx, appID); err != nil {
	log.Fatal(err)
}

Das Löschen ist endgültig. Erstelle zuerst einen Snapshot, wenn du die Dateien eventuell noch einmal brauchst.

Nächste Schritte

Commit und Upload

Eine App aus einer ZIP-Datei erstellen oder Dateien an eine App senden.

API-Referenz für Anwendungen

Die REST-Endpunkte hinter diesen Methoden.

Apps über die CLI verwalten

Dieselben Aktionen im Terminal.

CLI

VS Code

SDKs

Go-SDK: Anwendungen verwalten

Eine Anwendung abrufen

Status

Status aller Anwendungen

Starten, Stoppen und Neustarten

Logs

Metriken

Domains und Load Balancer

Eine Anwendung löschen

Nächste Schritte

Commit und Upload

API-Referenz für Anwendungen

Apps über die CLI verwalten

​Eine Anwendung abrufen

​Status

​Status aller Anwendungen

​Starten, Stoppen und Neustarten

​Logs

​Metriken

​Domains und Load Balancer

​Eine Anwendung löschen

​Nächste Schritte

Commit und Upload

API-Referenz für Anwendungen

Apps über die CLI verwalten

Eine Anwendung abrufen

Status

Status aller Anwendungen

Starten, Stoppen und Neustarten

Logs

Metriken

Domains und Load Balancer

Eine Anwendung löschen

Nächste Schritte