Obtener métricas de la base de datos

GET

databases

{database_id}

metrics

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

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/metrics"

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}/metrics', 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}/metrics",
  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}/metrics"

	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}/metrics")

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": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

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 el uso histórico de CPU, RAM, red, E/S de disco y almacenamiento de una base de datos, muestreado cada 5 minutos durante las últimas 24 horas (hasta 288 puntos), del más reciente al más antiguo. En los planes Pro y Enterprise, range=7d devuelve en su lugar los últimos 7 días, un punto por hora con el promedio y el pico de la hora. Úsalo para graficar el uso o para decidir si la base de datos necesita más memoria antes de llamar a Editar Base de Datos. Para una lectura actual en lugar de una serie temporal, usa Obtener Estado de la Base de Datos. Las respuestas se almacenan en caché durante 2.5 minutos por usuario y base de datos (10 minutos para 7d), y el endpoint tiene un límite de 10 solicitudes cada 5 segundos por usuario, con un bloqueo breve al alcanzar ese límite. Una base de datos sin muestras recientes devuelve un array vacío en lugar de un error.

Parámetros

string

requerido

El ID de la base de datos.

string

predeterminado:"24h"

La ventana del historial: 24h (un punto cada 5 minutos) o 7d (un punto por hora, planes Pro y Enterprise). En otros planes, 7d devuelve las últimas 24 horas en lugar de un error.

Respuesta

string

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

array

El contenido de la respuesta.

Mostrar propiedades

string

La fecha en formato ISO.

number

El porcentaje actual de uso de CPU.

number

El uso actual de RAM en MB.

int[]

Un array que representa el total de red utilizada. Primero la entrada, segundo la salida. Con range=7d, los totales se cuentan desde el punto más antiguo, así que la diferencia entre dos puntos consecutivos es el tráfico de esa hora.

int[]

Un array que representa el total de E/S de disco en bytes. Primero los bytes leídos, segundo los bytes escritos. Con la ventana por defecto 24h, los totales se cuentan desde que la base de datos se inició, así que la diferencia entre dos puntos consecutivos es la E/S de ese intervalo, y un total menor que el del punto anterior en el tiempo indica que la base de datos se reinició. Con range=7d, los totales se cuentan desde el punto más antiguo, así que la diferencia entre dos puntos consecutivos es la E/S de esa hora. null en un punto de 24h sin lectura, por ejemplo un punto registrado antes de que existiera este campo.

number

El espacio en disco, en bytes, que la base de datos está usando en el punto de tiempo dado (con range=7d, al final de esa hora). null cuando no hay lectura. Úsalo para seguir cómo crece el uso de disco a lo largo del tiempo.

number

Solo con range=7d: el porcentaje de uso de CPU más alto dentro de la hora (cpu es el promedio de la hora).

number

Solo con range=7d: el uso de RAM más alto en MB dentro de la hora (ram es el promedio de la hora).

{
    "status": "success",
    "response": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

Errores comunes

Código	HTTP	Significado
`INVALID_PARAMETERS`	400	`range` no es `24h` ni `7d`.
`DATABASE_NOT_FOUND`	404	La base de datos no existe o no pertenece al solicitante.

Relacionado

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

Obtener métricas de la base de datos

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

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/metrics"

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}/metrics', 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}/metrics",
  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}/metrics"

	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}/metrics")

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": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Obtener métricas de la base de datos

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado