Obter status da aplicação

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

string

obrigatório

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

Requer uma chave de API com o escopo apps:read. Retorna os valores atuais de CPU, RAM, armazenamento, rede e uptime da aplicação, formatados por padrão como strings legíveis por humanos (ex.: "120.4MB", "602 KB ↑ 134 KB ↓"). Passe rawData=true para obter os mesmos campos como números brutos, o que é mais fácil de trabalhar se você mesmo estiver plotando os valores em um gráfico. Se você também tiver uma conexão de Logs em tempo real aberta para a mesma aplicação, prefira os eventos status desse stream: enquanto uma conexão em tempo real estiver ativa, os números deste endpoint podem ficar até cerca de um minuto desatualizados. Para verificar todas as aplicações de uma vez em vez de uma por vez, veja Status de todas as aplicações.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.

boolean

Quando true, cpu, ram e os demais valores vêm como números em vez de strings formatadas.

Resposta

string

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

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O uso de CPU da aplicação.

string

A RAM em uso, por exemplo "120.4MB". Não inclui o limite alocado.

string

O status da aplicação.

boolean

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

string

O armazenamento usado pela aplicação.

object

Mostrar Alternar objeto

string

O uso total de rede da aplicação.

string

O uso de rede atual da aplicação.

number

O tempo de atividade (uptime) da aplicação em milissegundos.

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

Erros comuns

Código	HTTP	Significado
`APP_NOT_FOUND`	404	A aplicação não existe ou não pertence a quem fez a requisição.

Relacionados

CLI: squarecloud app status
SDKs: api.apps.status() (JavaScript), client.apps.status() (Python), c.Apps.Status() (Go)

Obter status da aplicação

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Obter status da aplicação

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados