SDK Go : gérer les applications

Toutes les méthodes de cette page se trouvent sur c.Apps et prennent d’abord ctx, puis l’identifiant de l’application. Un appID peut aussi être l’identifiant composite <appId>-<workspaceId> d’une application partagée via un workspace. Chaque extrait ci-dessous s’exécute seul dans ce programme : collez-en un à la fois dans main et lancez goimports (voir Exécuter les exemples).

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.
}

Pour lister vos applications, utilisez c.Account.Me : sa slice Applications contient toutes les applications que la clé peut voir.

Récupérer une application

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)

Champ	Type	Description
`ID` (`id`)	`string`	Identifiant de l’application
`Name` (`name`)	`string`	Nom affiché
`Description` (`desc`)	`string`	Description, `""` si elle n’est pas définie
`Owner` (`owner`)	`string`	Identifiant utilisateur du propriétaire
`Cluster` (`cluster`)	`string`	Cluster sur lequel l’application s’exécute
`RAM` (`ram`)	`int`	RAM allouée en Mo
`Language` (`language`)	`string`	Langage du runtime
`Domain` (`domain`)	`*string`	Hôte `<subdomain>.squareweb.app` par défaut ; `nil` pour les applications non web
`Custom` (`custom`)	`*string`	Domaine personnalisé ; `nil` si aucun n’est défini
`CreatedAt` (`created_at`)	`time.Time`	Date de création

Statut

Status(ctx, appID) renvoie l’état en direct avec des valeurs formatées :

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) renvoie des nombres à la place (CPU en %, RAM en Mo, Storage en octets, Network.Total et Network.Now sous forme de paires d’octets [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 est un horodatage (le moment où l’application a démarré), pas une durée. Utilisez time.Since(time.UnixMilli(*status.Uptime)) pour savoir depuis combien de temps elle tourne.

Statut de toutes les applications

StatusAll(ctx, workspaceID) renvoie un résumé par application que la clé peut voir, en une seule requête. Passez "" pour toutes les applications, ou un identifiant de workspace pour les seules applications de ce workspace. CPU et RAM ne sont renseignés (différents de "") que pendant que l’application s’exécute.

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")
	}
}

Démarrer, arrêter et redémarrer

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)
}

Le serveur maintient ces appels ouverts jusqu’à ce que le conteneur agisse : sans échéance sur ctx, ils attendent donc au moins 2 minutes avant d’expirer. Lorsque la plateforme refuse l’action, l’appel renvoie une *APIError avec le statut 409, un Code et un Message vide :

Code	Signification
`CONTAINER_ALREADY_STARTED`	`start` sur une application en cours d’exécution
`CONTAINER_ALREADY_STOPPED`	`stop` sur une application arrêtée
`CONTAINER_TEMPORARILY_SUSPENDED`	L’application est suspendue
`CONTAINER_NOT_FOUND`	Le conteneur n’existe pas sur le cluster
`CONTAINER_INSUFFICIENT_DISK_SPACE`	Pas assez d’espace disque pour démarrer
`CONTAINER_NETWORK_CONFLICT`	Conflit réseau sur le cluster
`ACTION_FAILED`	Le cluster n’a pas pu effectuer l’action

« Déjà démarrée » et « déjà arrêtée » sont aussi des erreurs. Si elles signifient un succès pour vous, gérez-les :

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) renvoie la dernière sortie de la console sous forme d’une seule chaîne ("" lorsqu’il n’y en a pas).

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

Pour un flux de logs en direct, utilisez le Temps réel.

Métriques

Metrics(ctx, appID) renvoie les dernières 24 heures, un point toutes les 5 minutes, du plus récent au plus ancien.

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)
}

Domaines et load balancers

Domains(ctx) liste les noms d’hôte par défaut et personnalisés de chaque application. LoadBalancers(ctx) liste les domaines partagés par plusieurs applications, avec la limite de votre plan.

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)
}

Pour définir un domaine personnalisé, voir Réseau.

Supprimer une application

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

La suppression est définitive. Créez d’abord un snapshot si vous risquez d’avoir de nouveau besoin des fichiers.

Prochaines étapes

Commit et envoi

Créez une application à partir d’un zip ou envoyez-lui des fichiers.

Référence de l'API des applications

Les endpoints REST derrière ces méthodes.

Gérer les applications depuis la CLI

Les mêmes actions depuis le terminal.

CLI

VS Code

SDKs

SDK Go : gérer les applications

Récupérer une application

Statut

Statut de toutes les applications

Démarrer, arrêter et redémarrer

Logs

Métriques

Domaines et load balancers

Supprimer une application

Prochaines étapes

Commit et envoi

Référence de l'API des applications

Gérer les applications depuis la CLI

​Récupérer une application

​Statut

​Statut de toutes les applications

​Démarrer, arrêter et redémarrer

​Logs

​Métriques

​Domaines et load balancers

​Supprimer une application

​Prochaines étapes

Commit et envoi

Référence de l'API des applications

Gérer les applications depuis la CLI

Récupérer une application

Statut

Statut de toutes les applications

Démarrer, arrêter et redémarrer

Logs

Métriques

Domaines et load balancers

Supprimer une application

Prochaines étapes