Status de todas as aplicações

GET

apps

status

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

import requests

url = "https://api.squarecloud.app/v2/apps/status"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/status")
  .header("Authorization", "<authorization>")
  .asString();

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
    }
  ]
}

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Retorna a CPU, a RAM e o estado de execução ao vivo de todas as aplicações que você possui em uma única chamada, o que é mais eficiente do que percorrer Obter status da aplicação uma vez por aplicação. Passe workspaceId para restringir a listagem a um workspace compartilhado em vez das suas próprias aplicações; quem chamar precisa ser o proprietário do workspace ou um membro dele. Este é o endpoint que a visão geral de aplicações do painel consulta via polling. Possui limite de taxa de 15 requisições a cada 60 segundos por usuário; o endpoint equivalente por aplicação tem seus próprios limites, separados. Para atualizações contínuas em vez de polling, abra uma conexão de Logs em tempo real por aplicação.

Parâmetros

workspaceId

string

Um ID de workspace. Você pode encontrá-lo abaixo do nome do seu workspace no painel.

Se workspaceId não for fornecido, será obtido o status das aplicações da sua conta.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID da aplicação.

cpu

string

O uso de CPU da aplicação.

ram

string

O uso de RAM da aplicação.

running

boolean

Indica se a aplicação está atualmente em execução.

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

Erros comuns

Código	HTTP	Significado
`WORKSPACE_NOT_FOUND`	404	O `workspaceId` não existe ou quem fez a chamada não é o proprietário nem um membro.

Obter status do serviçoVerificar o status em tempo real dos serviços da Square Cloud.

Status de todas as aplicações

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

import requests

url = "https://api.squarecloud.app/v2/apps/status"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/status")
  .header("Authorization", "<authorization>")
  .asString();

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
    }
  ]
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns