アプリケーションログの取得

GET

apps

{app_id}

logs

アプリケーションログの取得

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/logs', 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}/logs",
  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}/logs"

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

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": {
        "logs": "Working!"
    }
}

このエンドポイントには厳格なレート制限があります。いずれかの制限を超えると 429 Too Many Requests が返されます:

ユーザーごと、アプリケーションごとに 5 秒あたり 1 リクエスト。
全アプリケーションを通じてユーザーごとに 10 秒あたり 20 リクエスト、その後 30 秒のクールダウン。

429 を受け取った場合は、そのアプリケーションのポーリングを停止し、再試行する前に少なくともクールダウン（約 30 秒）待機してください。

このエンドポイントは、ログの特定時点のスナップショット（ログタブを開く、または手動更新）にのみ使用してください。ライブで継続的なログが必要な場合は、リアルタイムログ（SSE）エンドポイントを使用してください。こちらはこのレート制限に達することなくログをリアルタイムでストリーミングします。

string

必須

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

このエンドポイントは、クラスターから直接アプリケーションの最新の stdout/stderr バッファーを取得します。これはストリームではなく、短命なスナップショットです。stdout と stderr は書き込まれた順に連結して返され、各行がどちらのストリームかを区別する情報は含まれません。これは、各行の先頭にストリーム ID を付与するリアルタイムログイベントとは異なります。ページの読み込み時や手動更新ボタンの押下時にログタブを描画するなど、最近の出力を一度だけ確認したい場合に使用してください。アプリケーションがオフラインの場合、一度もデプロイされていない場合、またはクラスターが一時的なエラーを返した場合は 404 が返されます。アプリケーションへのアクセス権を持つ workspace メンバーは、所有者と同じ方法でこのエンドポイントを呼び出せます。

パラメータ

string

必須

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

レスポンス

string

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

object

レスポンスの内容。

表示オブジェクトを表示

string

アプリケーションの最新のログ。

{
    "status": "success",
    "response": {
        "logs": "Working!"
    }
}

リアルタイムログServer-Sent Events (SSE) 接続を確立して、アプリケーションのリアルタイムフィード（ログ、ライブメトリクス、ステータス、deploy の進行状況）を受信します。接続時には最新の 200 行のログが送信され、その後に新しい更新が続きます。接続は最大 10 分間維持できます。

アプリケーションログの取得

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_id}/logs', 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}/logs",
  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}/logs"

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

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": {
        "logs": "Working!"
    }
}

​パラメータ

​レスポンス

パラメータ

レスポンス