API 参考
获取服务状态
查看 Square Cloud 服务的实时状态。
GET
/
v2
/
service
/
status
获取服务状态
curl --request GET \
--url https://api.squarecloud.app/v2/service/status \
--header 'Authorization: <api-key>'import requests
url = "https://api.squarecloud.app/v2/service/status"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.squarecloud.app/v2/service/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/service/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: <api-key>"
],
]);
$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/service/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/service/status")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/service/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "online",
"message": "All services are online."
}
服务状态返回 Square Cloud 平台的整体健康状况,与公共状态页面和内部告警所使用的信号相同。这是一个无需 API 密钥的公开路由,非常适合用于自动化的可用性检查,或在你自己的网站上构建一个小型状态组件。
该响应内容来自 5 分钟的缓存,因此对于短暂的故障,最多可能有这个时间窗口的延迟,不应将其当作实时的故障信息源。如果缓存值无法读取,该端点仍会以
status: "unknown" 成功响应,而不会使请求失败。
如需查看单个应用而非整个平台的健康状况,请参阅获取应用状态或获取所有应用状态。
此路由有 5 分钟的缓存,不会反映 status.squarecloud.app 的实时状态。
响应
string
Square Cloud 的当前状态,其中
online 表示服务在线,degraded 表示存在问题,unknown 表示不可用。string
关于 Square Cloud 服务当前状态的消息。
{
"status": "online",
"message": "All services are online."
}
⌘I
获取服务状态
curl --request GET \
--url https://api.squarecloud.app/v2/service/status \
--header 'Authorization: <api-key>'import requests
url = "https://api.squarecloud.app/v2/service/status"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.squarecloud.app/v2/service/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/service/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: <api-key>"
],
]);
$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/service/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/service/status")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/service/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "online",
"message": "All services are online."
}

