Statut de toutes les applications

GET

apps

status

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

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

fetch('https://api.squarecloud.app/v2/apps/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/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/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/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": [
    {
      "id": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

string

requis

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

Renvoie en une seule requête le CPU, la RAM et l’état d’exécution en direct de chaque application que vous possédez, ce qui est plus efficace que de boucler sur Obtenir le statut d’une application pour chaque application. Passez workspaceId pour limiter la liste à un workspace partagé plutôt qu’à vos propres applications ; l’appelant doit être le propriétaire du workspace ou un membre. C’est l’endpoint interrogé par la vue d’ensemble des applications du tableau de bord. Il est limité à 15 requêtes toutes les 60 secondes par utilisateur ; l’endpoint équivalent par application a ses propres limites, distinctes. Pour des mises à jour continues plutôt que du polling, ouvrez une connexion Logs en temps réel par application.

Paramètres

string

Un identifiant de workspace. Vous pouvez le trouver sous le nom de votre workspace sur le tableau de bord.

Si workspaceId n’est pas fourni, le statut des applications de votre compte sera renvoyé.

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’ID de l’application.

string

L’utilisation CPU de l’application.

string

L’utilisation RAM de l’application.

boolean

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

{
  "status": "success",
  "response": [
    {
      "id": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

Erreurs courantes

Code	HTTP	Signification
`WORKSPACE_NOT_FOUND`	404	Le `workspaceId` n’existe pas ou l’appelant n’est ni le propriétaire ni un membre.

Obtenir l'état du serviceVérifiez l'état en temps réel des services de Square Cloud.

Statut de toutes les applications

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

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

fetch('https://api.squarecloud.app/v2/apps/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/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/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/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": [
    {
      "id": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes