SDK de Go: gestionar aplicaciones

Todos los métodos de esta página están en c.Apps y reciben primero ctx y después el id de la aplicación. Un appID también puede ser el id compuesto <appId>-<workspaceId> de una aplicación compartida a través de un workspace. Cada fragmento de abajo se ejecuta por sí solo dentro de este programa: pega uno a la vez en main y ejecuta goimports (consulta Ejecutar los ejemplos).

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

Para listar tus aplicaciones, usa c.Account.Me: su slice Applications contiene todas las aplicaciones que la clave puede ver.

Obtener una aplicación

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)

Campo	Tipo	Descripción
`ID` (`id`)	`string`	Id de la aplicación
`Name` (`name`)	`string`	Nombre visible
`Description` (`desc`)	`string`	Descripción, `""` cuando no está definida
`Owner` (`owner`)	`string`	Id de usuario del propietario
`Cluster` (`cluster`)	`string`	Clúster en el que se ejecuta la aplicación
`RAM` (`ram`)	`int`	RAM asignada en MB
`Language` (`language`)	`string`	Lenguaje del runtime
`Domain` (`domain`)	`*string`	Host por defecto `<subdomain>.squareweb.app`; `nil` en aplicaciones que no son web
`Custom` (`custom`)	`*string`	Dominio personalizado; `nil` cuando no hay ninguno configurado
`CreatedAt` (`created_at`)	`time.Time`	Fecha de creación

Estado

Status(ctx, appID) devuelve el estado en vivo con valores formateados:

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) devuelve números en su lugar (CPU en %, RAM en MB, Storage en bytes, Network.Total y Network.Now como pares de bytes [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 es una marca de tiempo (cuándo se inició la aplicación), no una duración. Usa time.Since(time.UnixMilli(*status.Uptime)) para saber cuánto tiempo lleva en marcha.

Estado de todas las aplicaciones

StatusAll(ctx, workspaceID) devuelve un resumen por cada aplicación que la clave puede ver, en una sola petición. Pasa "" para todas las aplicaciones, o el id de un workspace para obtener solo las aplicaciones de ese workspace. CPU y RAM solo tienen valor (no "") mientras la aplicación se ejecuta.

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

Iniciar, detener y reiniciar

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

El servidor mantiene estas llamadas abiertas hasta que el contenedor actúa, así que, sin un deadline en ctx, esperan al menos 2 minutos antes de agotar el tiempo. Cuando la plataforma rechaza la acción, la llamada devuelve un *APIError con estado 409, un Code y un Message vacío:

Código	Significado
`CONTAINER_ALREADY_STARTED`	`start` sobre una aplicación en ejecución
`CONTAINER_ALREADY_STOPPED`	`stop` sobre una aplicación detenida
`CONTAINER_TEMPORARILY_SUSPENDED`	La aplicación está suspendida
`CONTAINER_NOT_FOUND`	El contenedor no existe en el clúster
`CONTAINER_INSUFFICIENT_DISK_SPACE`	No hay suficiente disco para iniciar
`CONTAINER_NETWORK_CONFLICT`	Conflicto de red en el clúster
`ACTION_FAILED`	El clúster no pudo realizar la acción

“Ya iniciada” y “ya detenida” también son errores. Si para ti significan éxito, gestiónalos:

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) devuelve la salida de consola más reciente como un único string ("" cuando no hay ninguna).

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

Para un stream de logs en vivo, usa Tiempo real.

Métricas

Metrics(ctx, appID) devuelve las últimas 24 horas, un punto cada 5 minutos, del más reciente al más antiguo.

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

Dominios y balanceadores de carga

Domains(ctx) lista los nombres de host por defecto y personalizados de todas las aplicaciones. LoadBalancers(ctx) lista los dominios compartidos por varias aplicaciones, con el límite de tu 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)
}

Para configurar un dominio personalizado, consulta Red.

Eliminar una aplicación

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

La eliminación es permanente. Crea primero un snapshot si es posible que vuelvas a necesitar los archivos.

Próximos pasos

Commit y subida

Crea una aplicación a partir de un zip o envíale archivos.

Referencia de la API de aplicaciones

Los endpoints REST detrás de estos métodos.

Gestionar aplicaciones desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de Go: gestionar aplicaciones

Obtener una aplicación

Estado

Estado de todas las aplicaciones

Iniciar, detener y reiniciar

Logs

Métricas

Dominios y balanceadores de carga

Eliminar una aplicación

Próximos pasos

Commit y subida

Referencia de la API de aplicaciones

Gestionar aplicaciones desde la CLI

​Obtener una aplicación

​Estado

​Estado de todas las aplicaciones

​Iniciar, detener y reiniciar

​Logs

​Métricas

​Dominios y balanceadores de carga

​Eliminar una aplicación

​Próximos pasos

Commit y subida

Referencia de la API de aplicaciones

Gestionar aplicaciones desde la CLI

Obtener una aplicación

Estado

Estado de todas las aplicaciones

Iniciar, detener y reiniciar

Logs

Métricas

Dominios y balanceadores de carga

Eliminar una aplicación

Próximos pasos