Obter status do banco de dados

GET

databases

{database_id}

status

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

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/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/databases/{database_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/databases/{database_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/databases/{database_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))

}

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

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_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.54%",
        "ram": "111.32MB",
        "status": "running",
        "running": true,
        "storage": "210.1MB",
        "network": {
            "total": "16.83KB ↑ 126B ↓",
            "now": "0B ↑ 0B ↓"
        },
        "uptime": 1755028584438
    }
}

Authorization

string

obrigatório

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

Retorna estatísticas de execução em tempo real para um único banco de dados: CPU, RAM, uso de rede, armazenamento e tempo de atividade. Passe rawData=true para obter valores numéricos brutos em vez das strings formatadas ("0.54%", "111.32MB") mostradas no exemplo abaixo, útil quando você quer fazer sua própria formatação ou cálculo no lado do cliente. Para obter isso de todos os bancos de dados de uma vez, use Status de Todos os Bancos de Dados. Para tendências históricas em vez de uma leitura ao vivo, veja Obter Métricas do Banco de Dados.

Parâmetros

database_id

string

obrigatório

O ID do banco de dados.

rawData

boolean

Retornar dados não-formatados. Verdadeiro, retorna os valores em bytes.

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

cpu

string

A porcentagem atual de uso da CPU.

ram

string

O uso atual de RAM

running

boolean

Valor booleano indicando se está em execução.

storage

string

O armazenamento atual que está sendo utilizado.

network

object

O uso de rede e o total utilizado.

Mostrar Alternar objeto

total

string

O total utilizado.

now

string

O uso atual.

uptime

int

O timestamp representando o tempo de atividade (uptime).

{
    "status": "success",
    "response": {
        "cpu": "0.54%",
        "ram": "111.32MB",
        "status": "running",
        "running": true,
        "storage": "210.1MB",
        "network": {
            "total": "16.83KB ↑ 126B ↓",
            "now": "0B ↑ 0B ↓"
        },
        "uptime": 1755028584438
    }
}

Erros comuns

Código	HTTP	Significado
`DATABASE_NOT_FOUND`	404	O banco de dados não existe ou não pertence a quem fez a chamada.

Obter métricas do banco de dadosObter as métricas do seu banco de dados hospedado.

Obter status do banco de dados

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

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/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/databases/{database_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/databases/{database_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/databases/{database_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))

}

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

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_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.54%",
        "ram": "111.32MB",
        "status": "running",
        "running": true,
        "storage": "210.1MB",
        "network": {
            "total": "16.83KB ↑ 126B ↓",
            "now": "0B ↑ 0B ↓"
        },
        "uptime": 1755028584438
    }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns