Obtener Estado de la Base de Datos

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

}

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

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Requiere una clave de API con el scope databases:read. Devuelve estadísticas en vivo de una sola base de datos: CPU, RAM, uso de red, almacenamiento y tiempo de actividad. Pasa rawData=true para obtener valores numéricos sin procesar en lugar de las cadenas formateadas ("0.54%", "111.32MB") que se muestran en el ejemplo de abajo, útil cuando quieres hacer tu propio formateo o cálculos del lado del cliente. Para obtener esto de todas las bases de datos propias a la vez, usa Estado de Todas las Bases de Datos. Para tendencias históricas en lugar de una lectura en vivo, consulta Obtener Métricas de la Base de Datos.

Parámetros

string

requerido

El ID de la base de datos.

boolean

Cuando es true, cpu, ram y las demás cifras vienen como números en lugar de cadenas formateadas.

Respuesta

string

Indica si la llamada fue exitosa: success si lo fue, error si no.

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

El porcentaje actual de uso de CPU.

string

La RAM en uso, por ejemplo "120.4MB". No incluye el límite asignado.

boolean

El valor booleano que indica si está en ejecución.

string

El almacenamiento que está usando actualmente.

object

El uso de red y el total utilizado.

Mostrar Alternar objeto

string

El total utilizado.

string

El uso actual.

int

El timestamp que representa el tiempo de actividad.

{
    "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
    }
}

Errores comunes

Código	HTTP	Significado
`DATABASE_NOT_FOUND`	404	La base de datos no existe o no pertenece al solicitante.

Relacionado

CLI: squarecloud db status
SDKs: api.databases.status() (JavaScript), client.databases.status() (Python), c.Databases.Status() (Go)

Obtener Estado de la Base de Datos

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

}

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

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Obtener Estado de la Base de Datos

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado