Obtenir les logs de l'application

GET

apps

{app_id}

logs

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/logs \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "logs": "Working!"
    }
}

Cet endpoint est strictement limité en débit. Dépasser l’une des limites renvoie 429 Too Many Requests :

1 requête toutes les 5 secondes par utilisateur et par application.
20 requêtes toutes les 10 secondes par utilisateur, toutes applications confondues, suivies d’un court cooldown.

Lorsque vous recevez un 429, arrêtez d’interroger cette application et attendez la fin du cooldown avant de réessayer.

Utilisez cet endpoint uniquement pour un instantané des logs à un moment donné (ouverture de l’onglet des logs ou rafraîchissement manuel). Pour des logs continus en temps réel, utilisez l’endpoint Logs en temps réel (SSE), qui diffuse les logs en temps réel sans atteindre cette limite de débit.

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope apps:read. Cet endpoint récupère directement depuis le cluster le tampon stdout/stderr le plus récent de l’application : c’est un instantané de courte durée, pas un flux. stdout et stderr sont renvoyés concaténés dans l’ordre où ils ont été écrits, sans distinction ligne par ligne entre les deux, contrairement à l’événement Logs en temps réel qui préfixe chaque ligne avec l’identifiant de son flux. Utilisez-le lorsque vous avez besoin d’un aperçu ponctuel des sorties récentes, par exemple pour afficher l’onglet des logs au chargement de la page ou après un rafraîchissement manuel. Il renvoie 404 lorsque l’application est hors ligne, n’a jamais été déployée, ou lorsque le cluster renvoie une erreur transitoire. Les membres du workspace ayant accès à l’application peuvent l’appeler de la même manière que le propriétaire.

Paramètres

string

requis

L’ID de l’application. Vous le trouverez dans l’URL du dashboard de votre application.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

Les derniers logs de l’application.

{
    "status": "success",
    "response": {
        "logs": "Working!"
    }
}

Erreurs courantes

Code	HTTP	Signification
`LOGS_UNAVAILABLE`	404	Les logs n’ont pas pu être renvoyés : l’application est hors ligne, n’a jamais été déployée ou une erreur transitoire s’est produite. Réessayez sous peu.

Voir aussi

CLI : squarecloud app logs
SDK : api.apps.logs() (JavaScript), client.apps.logs() (Python), c.Apps.Logs() (Go)

Obtenir les logs de l'application

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/logs \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "logs": "Working!"
    }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Obtenir les logs de l'application

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi