アプリケーションのステータス取得

GET

apps

{app_id}

status

アプリケーションのステータス取得

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/status \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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.01%",
        "ram": "120.4MB",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

apps:read スコープを持つ API キーが必要です。アプリケーションの現在の CPU、RAM、ストレージ、ネットワーク、稼働時間の値を返します。デフォルトでは人が読みやすい文字列としてフォーマットされます（例: "120.4MB"、"602 KB ↑ 134 KB ↓"）。rawData=true を渡すと、同じフィールドを生の数値として取得でき、自分でグラフを描画する場合に扱いやすくなります。同じアプリケーションに対してリアルタイムログ接続も開いている場合は、そのストリームの status イベントを優先してください。リアルタイム接続がアクティブな間、このエンドポイントの数値は最大で約 1 分ほど遅れることがあります。すべてのアプリケーションを一度に確認したい場合は、1 つずつ確認する代わりに全アプリケーションのステータスを参照してください。

パラメーター

string

必須

アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。

boolean

true の場合、cpu、ram などの値がフォーマット済みの文字列ではなく数値で返されます。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

レスポンスの内容。

表示オブジェクトを切り替える

string

アプリケーションのCPU使用率。

string

使用中の RAM です。例: "120.4MB"。割り当てられた上限は含みません。

string

アプリケーションのステータス。

boolean

アプリケーションが現在実行中かどうかを示します。

string

アプリケーションが使用しているストレージ。

object

表示オブジェクトを切り替える

string

アプリケーションの合計ネットワーク使用量。

string

アプリケーションの現在のネットワーク使用量。

number

アプリケーションの稼働時間（ミリ秒単位）。

{
    "status": "success",
    "response": {
        "cpu": "0.01%",
        "ram": "120.4MB",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

一般的なエラー

コード	HTTP	説明
`APP_NOT_FOUND`	404	アプリケーションが存在しないか、呼び出し元に所有されていません。

関連項目

CLI: squarecloud app status
SDK: api.apps.status() (JavaScript), client.apps.status() (Python), c.Apps.Status() (Go)

アプリケーションのステータス取得

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/status \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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.01%",
        "ram": "120.4MB",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

はじめに

アカウント