Obtenir les métriques d'une base de données

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
            ]
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ]
        }
    ]
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope databases:read. Renvoie l’historique d’utilisation du CPU, de la RAM et du réseau d’une base de données, échantillonné toutes les 5 minutes sur les dernières 24 heures (jusqu’à 288 points), du plus récent au plus ancien. Utilisez-la pour tracer des graphiques d’utilisation ou pour décider si la base de données a besoin de plus de mémoire avant d’appeler Modifier une base de données. Pour une seule lecture actuelle plutôt qu’une série temporelle, utilisez Récupérer le statut d’une base de données. Les réponses sont mises en cache pendant 2,5 minutes par utilisateur et par base de données, et l’endpoint est limité à 10 requêtes par 5 secondes par utilisateur, avec un court blocage une fois ce plafond atteint. Une base de données sans échantillon récent renvoie un tableau vide plutôt qu’une erreur.

Paramètres

string

requis

L’ID de la base de données.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

array

Le contenu de la réponse.

Afficher Afficher l'objet

string

La date au format ISO.

number

Le pourcentage d’utilisation actuel du CPU.

number

L’utilisation actuelle de la RAM en MB.

int[]

Un tableau représentant le trafic réseau total. D’abord l’entrée, ensuite la sortie.

{
    "status": "success",
    "response": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ]
        }
    ]
}

Erreurs courantes

Code	HTTP	Signification
`DATABASE_NOT_FOUND`	404	La base de données n’existe pas ou n’appartient pas à l’appelant.

Voir aussi

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

Obtenir les métriques d'une base de données

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
            ]
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ]
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ]
        }
    ]
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Obtenir les métriques d'une base de données

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi