SDK de Go: gestor de archivos de la app

El gestor de archivos está en c.Apps.Files. Todos los métodos reciben primero ctx y el id de la aplicación, y después una ruta dentro de la aplicación. Las rutas tienen como máximo 256 caracteres. 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.
}

Listar un directorio

Files.List(ctx, appID, path) lista un directorio ("" para la raíz de la aplicación).

entries, err := c.Apps.Files.List(ctx, appID, "/src")
if err != nil {
	log.Fatal(err)
}
for _, entry := range entries {
	fmt.Println(entry.Type, entry.Name, entry.Size)
	if entry.LastModified != nil {
		fmt.Println(time.UnixMilli(int64(*entry.LastModified)))
	}
}

Campo	Tipo	Descripción
`Name` (`name`)	`string`	Nombre de la entrada
`Type` (`type`)	`string`	`"file"` o `"directory"`
`Size` (`size`)	`int64`	Tamaño en bytes. `0` en las entradas de directorio que la API envía sin él
`LastModified` (`lastModified`)	`*float64`	Ms Unix (puede incluir decimales); `nil` cuando no se puede leer

Un directorio que no existe da 404 FILE_NOT_FOUND. Una ruta que el gestor de archivos no expone da 403 BLOCKED_PATH.

Leer un archivo

Files.Read(ctx, appID, path) devuelve los bytes del archivo como un []byte. Los archivos están limitados a 10 MB: uno más grande da 413 FILE_TOO_LARGE.

data, err := c.Apps.Files.Read(ctx, appID, "/config.json")
if err != nil {
	log.Fatal(err)
}

var config map[string]any
if err := json.Unmarshal(data, &config); err != nil {
	log.Fatal(err)
}
fmt.Println(config)

Escribir un archivo

Files.Write(ctx, appID, path, content) crea o sobrescribe un archivo. content es un []byte:

Siempre se envía en base64, así que el contenido de texto y el binario se conservan byte a byte. Para escribir un string, pasa []byte(s).
Un contenido vacío (nil o un slice vacío) crea un archivo vacío.

// Text
config, err := json.Marshal(map[string]bool{"debug": false})
if err != nil {
	log.Fatal(err)
}
if err := c.Apps.Files.Write(ctx, appID, "/config.json", config); err != nil {
	log.Fatal(err)
}

// Binary
res, err := http.Get("https://example.com/logo.png")
if err != nil {
	log.Fatal(err)
}
defer res.Body.Close()
image, err := io.ReadAll(res.Body)
if err != nil {
	log.Fatal(err)
}
if err := c.Apps.Files.Write(ctx, appID, "/assets/logo.png", image); err != nil {
	log.Fatal(err)
}

Un contenido de más de 10 MB falla localmente con FILE_TOO_LARGE (estado 0) antes de enviar nada. Un contenido de más de 1 MiB no tiene deadline por defecto, como una subida: limítalo o cancélalo con ctx. Para archivos más grandes, usa Apps.Commit.

Escribir no reinicia la aplicación. Llama a Apps.Restart para aplicar el cambio.

Mover o renombrar un archivo

if err := c.Apps.Files.Move(ctx, appID, "/config.json", "/config.old.json"); err != nil {
	log.Fatal(err)
}

Eliminar un archivo

if err := c.Apps.Files.Delete(ctx, appID, "/config.old.json"); err != nil {
	log.Fatal(err)
}

Errores

Estado	Código	Cuándo
0	`FILE_TOO_LARGE`	Contenido de `Write` de más de 10 MB (se comprueba localmente)
400	`INVALID_PATH`	La ruta no supera la validación (traversal, caracteres no válidos, demasiado larga), o `Move` a la misma ruta
400	`DELETE_FAILED`, `RENAME_FAILED`	El clúster no pudo eliminar o renombrar el archivo
403	`BLOCKED_PATH`	El gestor de archivos no expone la ruta
403	`PERMISSION_DENIED`	Tu rol en el workspace no puede tocar un archivo restringido (como `.env`)
404	`FILE_NOT_FOUND`	El archivo o directorio no existe
413	`FILE_TOO_LARGE`	`Read` de un archivo de más de 10 MB
429	`KEEP_CALM`	Más de 10 escrituras en 5 segundos

Consulta Errores para ver los códigos que puede devolver cualquier llamada.

Próximos pasos

Variables de entorno

Lee y cambia las variables de una aplicación.

Referencia de la API del gestor de archivos

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

Gestionar archivos desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de Go: gestor de archivos de la app

Listar un directorio

Leer un archivo

Escribir un archivo

Mover o renombrar un archivo

Eliminar un archivo

Errores

Próximos pasos

Variables de entorno

Referencia de la API del gestor de archivos

Gestionar archivos desde la CLI

​Listar un directorio

​Leer un archivo

​Escribir un archivo

​Mover o renombrar un archivo

​Eliminar un archivo

​Errores

​Próximos pasos

Variables de entorno

Referencia de la API del gestor de archivos

Gestionar archivos desde la CLI

Listar un directorio

Leer un archivo

Escribir un archivo

Mover o renombrar un archivo

Eliminar un archivo

Errores

Próximos pasos