Anwendungslogs abrufen - Square Cloud

GET

apps

{app_id}

logs

Anwendungslogs abrufen

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

Dieser Endpoint ist streng rate-limitiert. Das Überschreiten eines der Limits liefert 429 Too Many Requests:

1 Anfrage alle 5 Sekunden pro Benutzer und pro Anwendung.
20 Anfragen alle 10 Sekunden pro Benutzer über alle Anwendungen hinweg, gefolgt von einer Abkühlphase von 30 Sekunden.

Wenn du einen 429 erhältst, stoppe das Polling dieser Anwendung und warte mindestens die Abkühlphase (~30 Sekunden), bevor du es erneut versuchst.

Verwende diesen Endpoint nur für eine Momentaufnahme der Logs (Öffnen des Log-Tabs oder manuelle Aktualisierung). Für fortlaufende Live-Logs verwende den Echtzeit-Logs-Endpoint (SSE), der Logs in Echtzeit streamt, ohne an dieses Rate-Limit zu stoßen.

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Dieser Endpoint ruft den aktuellsten stdout/stderr-Puffer der Anwendung direkt vom Cluster ab: Es handelt sich um eine kurzlebige Momentaufnahme, nicht um einen Stream. stdout und stderr werden in der Reihenfolge, in der sie geschrieben wurden, aneinandergehängt zurückgegeben, ohne zeilenweise Unterscheidung zwischen den beiden, anders als beim Echtzeit-Logs-Event, das jeder Zeile ihre Stream-ID voranstellt. Verwende ihn, wenn du einen einmaligen Blick auf die letzten Ausgaben brauchst, etwa um den Logs-Tab beim Laden der Seite oder nach einem manuellen Aktualisieren-Button zu rendern. Er liefert 404, wenn die Anwendung offline ist, noch nie bereitgestellt wurde oder der Cluster einen vorübergehenden Fehler zurückgibt. Workspace-Mitglieder mit Zugriff auf die Anwendung können ihn genauso aufrufen wie der Eigentümer.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Die neuesten Logs der Anwendung.

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

Zurück

Echtzeit-LogsBaut eine Server-Sent-Events-Verbindung (SSE) auf, um den Echtzeit-Feed deiner Anwendung zu empfangen (Logs, Live-Metriken, Status, Deploy-Fortschritt). Beim Verbindungsaufbau werden die 200 aktuellsten Log-Zeilen gesendet, gefolgt von neuen Aktualisierungen. Die Verbindung kann bis zu 10 Minuten aufrechterhalten werden.

Weiter

Anwendungslogs abrufen

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

​Parameter

​Antwort

Parameter

Antwort