获取应用日志 - Square Cloud

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。有权访问该应用的工作区成员可以像所有者一样调用此接口。

参数

string

必填

应用的 ID。你可以在应用控制面板的 URL 中找到它。

响应

string

指示调用是否成功。成功时为 success，否则为 error。

object

响应的内容。

显示展开对象

string

应用最新的日志。

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

实时日志建立一个 Server-Sent Events (SSE) 连接以接收应用的实时数据流（日志、实时指标、状态、部署进度）。连接建立后，会先发送最近的 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!"
    }
}

​参数

​响应

参数

响应