网络错误 - Square Cloud

GET

apps

{app_id}

network

errors

网络错误

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

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/apps/{app_id}/network/errors', 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}/network/errors",
  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}/network/errors"

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

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": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

返回应用在某一时间窗口内的聚合边缘错误计数，按状态码、时间分桶、请求路径和 HTTP 方法分组。默认仅包含 5xx 响应；传入 include_4xx=true 可同时统计 4xx 响应。

缓存未命中速率限制：每个所有者每 60 秒 15 次请求。当没有匹配的错误，或时间窗口早于应用的创建日期时，返回空明细。

string

必填

你账户的 API 密钥。你可以在账户设置中找到它。

由于 4xx 错误中包含扫描探测、失效链接这类由客户端引起的命中，默认会被排除；只有在确实需要这些噪音数据时，例如审计机器人流量时，才启用 include_4xx=true。5xx 状态码反映的是边缘或应用本身的问题，因此始终会被包含在内。此端点在所有付费套餐上均可用，与网站分析相同。如果你需要的是逐请求的明细而不是聚合计数，请参见网络日志（仅限 Pro 和 Enterprise）。如果关心的是延迟而非错误率，请参见网络性能。

参数

string

必填

应用的 ID。你可以在应用仪表盘的 URL 中找到它。

string

必填

分析窗口的 ISO 8601 起始时间戳。

string

必填

ISO 8601 结束时间戳。必须晚于 start。

string

是否在 5xx 错误之外同时包含 4xx 响应。接受 true 或 false。默认为 false。

响应

string

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

object

该窗口的聚合错误明细。

显示展开响应对象

object

该窗口的高层级总计。

显示展开 summary 对象

integer

窗口内错误响应的总数。

object

按 HTTP 状态类别拆分的总计。

显示展开 by_class 对象

integer

4xx 响应总数（仅在 include_4xx=true 时填充）。

integer

5xx 响应总数。

array

按观测到的每个单独 HTTP 状态码分组的请求数量。

显示展开 by_status 条目

integer

HTTP 状态码（例如 502、504）。

integer

返回此状态码的请求总数。

array

分析窗口内按时间分桶的计数。

显示展开 timeseries 条目

string

分桶起始时间戳，ISO 8601 格式。

object

以 HTTP 状态码为键、该分桶内观测计数为值的对象。

integer

该分桶内观测到的错误总数。

array

在该窗口内产生最多错误的路径。

显示展开 top_paths 条目

string

请求路径。

string

HTTP 方法。

integer

此路径/方法的错误总数。

object

此路径/方法下观测到的各 HTTP 状态码计数。

array

按 HTTP 方法分组的聚合错误总数。

显示展开 by_method 条目

string

HTTP 方法。

integer

此方法的错误总数。

object

此方法下观测到的各 HTTP 状态码计数。

{
  "status": "success",
  "response": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

常见错误

代码	HTTP	说明
`INVALID_TIME_RANGE`	400	`start`/`end` 缺失、格式错误，或起止时间顺序颠倒。
`UNABLE_TO_FETCH_ERRORS`	500	从边缘提供商获取错误数据失败。

网络性能获取应用的边缘与源站延迟百分位数，并按国家、colo 和路径进行细分。

网络错误

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/errors"

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/apps/{app_id}/network/errors', 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}/network/errors",
  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}/network/errors"

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

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": {
    "summary": {
      "total": 42,
      "by_class": {
        "4xx": 0,
        "5xx": 42
      }
    },
    "by_status": [
      { "status": 502, "requests": 30 },
      { "status": 504, "requests": 12 }
    ],
    "timeseries": [
      {
        "date": "2025-12-01T12:00:00.000Z",
        "buckets": { "502": 5, "504": 2 },
        "total": 7
      }
    ],
    "top_paths": [
      {
        "path": "/api/users",
        "method": "GET",
        "total": 18,
        "by_status": { "502": 15, "504": 3 }
      }
    ],
    "by_method": [
      {
        "method": "GET",
        "total": 30,
        "by_status": { "502": 22, "504": 8 }
      }
    ]
  }
}

​参数

​响应

​常见错误

参数

响应

常见错误