SDK Python : gérer les applications

Toutes les méthodes de cette page se trouvent sur client.apps et prennent d’abord l’identifiant de l’application. Un app_id peut aussi être l’identifiant composite <appId>-<workspaceId> d’une application partagée via un workspace.

import os

from squarecloud import SquareCloud

client = SquareCloud(os.environ["SQUARECLOUD_API_KEY"])
app_id = "abc123def456abc123def456"

Avec AsyncSquareCloud, chaque appel ci-dessous est identique, précédé de await. Pour lister vos applications, utilisez client.account.me() : sa liste applications contient toutes les applications que la clé peut voir.

Récupérer une application

app = client.apps.get(app_id)

print(app["id"], app["name"], app["language"], app["ram"], app["cluster"], app["created_at"])

Champ	Type	Description
`id`	`str`	Identifiant de l’application
`name`	`str`	Nom affiché
`desc`	`str`, optionnel	Description
`owner`	`str`	Identifiant utilisateur du propriétaire
`cluster`	`str`	Cluster sur lequel l’application s’exécute
`ram`	`int`	RAM allouée en Mo
`language`	`str`	Langage du runtime
`domain`	`str \| None`, optionnel	Hôte `<subdomain>.squareweb.app` par défaut ; absent ou `None` pour les applications non web
`custom`	`str \| None`, optionnel	Domaine personnalisé ; absent ou `None` si aucun n’est défini
`created_at`	`str`	Date de création (ISO 8601)

Les champs optionnels peuvent être absents du dict : lisez-les avec app.get("domain").

Statut

status(app_id) renvoie l’état en direct avec des valeurs formatées :

status = client.apps.status(app_id)

print(status["status"])   # e.g. "running", "exited"
print(status["running"])  # True
print(status["cpu"])      # "0.5%"
print(status["ram"])      # "120.4MB" (RAM in use)
print(status["storage"], status["network"]["total"], status["network"]["now"])
print(status["uptime"])   # Unix ms of the last start, None when stopped

Passez raw=True pour obtenir des nombres à la place (cpu en %, ram en Mo, network["total"] et network["now"] sous forme de paires d’octets [in, out]) :

raw = client.apps.status(app_id, raw=True)

print(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.time() * 1000 - status["uptime"] pour savoir depuis combien de temps elle tourne, en ms.

Statut de toutes les applications

status_all() renvoie un résumé par application que la clé peut voir, en une seule requête. cpu et ram ne sont présents que pendant que l’application s’exécute.

for item in client.apps.status_all():
    print(item["id"], f"{item['cpu']} {item['ram']}" if item["running"] else "stopped")

# Only the apps of one workspace
shared = client.apps.status_all(workspace_id=workspace_id)

Démarrer, arrêter et redémarrer

client.apps.start(app_id)
client.apps.stop(app_id)
client.apps.restart(app_id)

Le serveur maintient ces appels ouverts jusqu’à ce que le conteneur agisse : ils attendent donc au moins 120 s avant d’expirer. Lorsque la plateforme refuse l’action, l’appel lève une SquareCloudAPIError 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 :

from squarecloud import SquareCloudAPIError

try:
    client.apps.start(app_id)
except SquareCloudAPIError as error:
    if error.code != "CONTAINER_ALREADY_STARTED":
        raise

Logs

logs(app_id) renvoie la dernière sortie de la console sous forme d’une seule chaîne ('' lorsqu’il n’y en a pas).

print(client.apps.logs(app_id))

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

Métriques

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

latest = client.apps.metrics(app_id)[0]

print(latest["date"], latest["cpu"], latest["ram"], latest["net"])

Domaines et load balancers

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

for domain in client.apps.domains():
    print(domain["app_id"], domain["hostname"], domain["type"])  # type: "subdomain" | "custom"

balancers = client.apps.load_balancers()
print(balancers["limit"])
for balancer in balancers["balancers"]:
    print(balancer["hostname"], [app["id"] for app in balancer["apps"]])

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

Supprimer une application

client.apps.delete(app_id)

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 Python : 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