Récupérer le statut d'une base de données

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

requis

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

Renvoie les statistiques d’exécution en direct d’une seule base de données : CPU, RAM, utilisation réseau, stockage et disponibilité. Passez rawData=true pour obtenir les valeurs numériques brutes au lieu des chaînes formatées ("0.54%", "111.32MB") montrées dans l’exemple ci-dessous, utile lorsque vous souhaitez effectuer votre propre formatage ou vos propres calculs côté client. Pour récupérer ces informations pour toutes les bases de données possédées en un seul appel, utilisez Statut de toutes les bases de données. Pour des tendances historiques plutôt qu’une lecture en direct, consultez Obtenir les métriques d’une base de données.

Paramètres

string

requis

L’ID de la base de données.

boolean

Si vous souhaitez les données brutes. True renvoie les valeurs en octets.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

Le pourcentage actuel d’utilisation du CPU.

string

L’utilisation actuelle de la RAM

boolean

La valeur booléenne indiquant si elle est en cours d’exécution.

string

Le stockage actuellement utilisé.

object

L’utilisation réseau et le total utilisé.

Afficher Afficher l'objet

string

Le total utilisé.

string

L’utilisation actuelle.

int

Le timestamp représentant la durée de fonctionnement.

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

Erreurs courantes

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

Obtenir les métriques d'une base de donnéesObtenir les métriques de votre base de données hébergée.

Récupérer le statut d'une base de données

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

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes