Obtenir le statut d'une application

GET

apps

{app_id}

status

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/status', 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}/status",
  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}/status"

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

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": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

string

requis

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

Renvoie les chiffres actuels de CPU, RAM, stockage, réseau et temps de fonctionnement de l’application, formatés par défaut en chaînes lisibles (par exemple "31.79" Mo, "602 KB ↑ 134 KB ↓"). Passez rawData=true pour obtenir les mêmes champs sous forme de nombres bruts, ce qui est plus pratique si vous représentez vous-même les valeurs sur un graphique. Si vous avez également une connexion Logs en temps réel ouverte pour la même application, privilégiez les événements status de ce flux : pendant qu’une connexion temps réel est active, les chiffres de cet endpoint peuvent accuser un retard d’environ une minute. Pour vérifier toutes les applications à la fois plutôt qu’une par une, consultez Statut de toutes les applications.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

boolean

Si vous souhaitez des données brutes. True renvoie les valeurs en octets.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’utilisation CPU de l’application.

string

L’utilisation RAM de l’application.

string

Le statut de l’application.

boolean

Indique si l’application est actuellement en cours d’exécution.

string

Le stockage utilisé par l’application.

object

Afficher Afficher l'objet

string

L’utilisation réseau totale de l’application.

string

L’utilisation réseau actuelle de l’application.

number

La durée de fonctionnement de l’application en millisecondes.

{
    "status": "success",
    "response": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

Erreurs courantes

Code	HTTP	Signification
`APP_NOT_FOUND`	404	L’application n’existe pas ou n’appartient pas à l’appelant.

Obtenir les logs de l'applicationRécupérez les 1000 dernières lignes de logs de votre application. Limité à 1 requête toutes les 5 secondes.

Obtenir le statut d'une application

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/status', 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}/status",
  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}/status"

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

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": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes