データベース
データベースのステータス取得
単一のデータベースに関連するすべてのステータス情報を取得します。
GET
/
v2
/
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
}
}
単一のデータベースについて、CPU、RAM、ネットワーク使用量、ストレージ、稼働時間といったライブのランタイム統計を返します。
rawData=true を渡すと、以下の例に示すような整形済みの文字列("0.54%"、"111.32MB")ではなく、生の数値を取得できます。クライアント側で独自の整形や計算を行いたい場合に便利です。
所有するすべてのデータベースについて一度に取得するには、全データベースのステータスを使用してください。ライブの値ではなく履歴トレンドが必要な場合は、データベースメトリクスの取得を参照してください。
Parameters
string
必須
データベースのID。
boolean
生データが必要な場合。Trueにすると、値をバイト単位で返します。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
{
"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
}
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
DATABASE_NOT_FOUND | 404 | データベースが存在しないか、呼び出し元が所有していません。 |
⌘I
データベースのステータス取得
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
}
}

