主题
域名分析错误任务查询
接口说明
通过本接口可以获取 过去 7 天返回错误的 Domain Analytics API 任务 信息。
型场景例如:你为任务了 webhook(pingback 或 postback),但由于服务器异常没有成功收到回调,此时可以通过错误查询接口拿到对应任务 ID,再结合 /v3/appendix/webhook_resend/ 重新发送 webhook。
如果某个任务没有出现在返回结果中,通常表示以下两种之一:
- 该任务并未返回错误;
- 该任务尚未执行完成。
计费说明
调用本接口 不收费。
可参考响应中的 cost 字段确认扣费;本接口通常为 0。
请求地址
POST https://api.seermartech.cn/v3/domain_analytics/errors
请求格式
所有 POST 数据均需使用 JSON(UTF-8 编码)提交。
请求体为 JSON 数组 格式:
json
[
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
limit | integer | 返回错误任务的最大数量。可选;默认值:1000;最大值:1000。 |
offset | integer | 返回结果中的偏移量。可选;默认值:0。例如设置为 10 时,将跳过前 10 条任务,从后续任务开始返回。 |
filtered_function | string | 按指定功能过滤错误任务。可选。可使用接口响应中 function 字段的值进行筛选。适用于获取未过滤结果,再按功能二次筛选。示例:domain_analytics/task_get、postback_url、pingback_url。 |
datetime_from | string | 结果起始时间。可选。用于按 datetime 过滤最近 7 天的数据。使用 UTC 时间格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2021-11-15 12:57:46 +00:00 |
datetime_to | string | 结果结束时间。可选。用于按 datetime 过滤最近 7 天的数据。使用 UTC 时间格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2021-11-15 13:57:46 +00:00 |
响应结构
接口返回 JSON 数据,核心位于 tasks 数组中。
顶层字段
| 字段名 | 类型 | 说明 |
|---|---|---|
version | string | 当前 API 版本。 |
status_code | integer | 接口总状态码。完整列表见 /v3/appendix/errors。 |
status_message | string | 接口总状态信息。完整列表见 /v3/appendix/errors。 |
time | string | 请求总耗时,单位:秒。 |
cost | float | 本次请求总成本,单位:USD。该接口通常为 0。 |
tasks_count | integer | tasks 数组中的任务数量。 |
tasks_error | integer | tasks 数组中返回错误的任务数量。 |
tasks | array | 任务数组。 |
tasks 数组字段
| 字段名 | 类型 | 说明 |
|---|---|---|
id | string | 任务唯一标识,UUID 格式。 |
status_code | integer | 任务状态码,由平台 API 生成,范围通常为 10000–60000。完整列表见 /v3/appendix/errors。 |
status_message | string | 任务状态说明。 |
time | string | 任务执行耗时,单位:秒。 |
cost | float | 单任务成本,单位:USD。 |
result_count | integer | result 数组中的数量。 |
path | array | 请求路径。 |
data | array / object | 与 POST 请求中提交的参数一致。 |
result | array | 错误结果数组。 |
result 数组字段
| 字段名 | 类型 | 说明 |
|---|---|---|
id | string | 任务 ID。 |
datetime | string | 错误发生时间,UTC 格式:yyyy-mm-dd hh-mm-ss +00:00。示例:2019-11-15 12:57:46 +00:00 |
function | string | 对应的 API 功能名称。 |
error_code | integer | 错误码。 |
error_message | string | 错误信息,或触发错误的 URL。详见 /v3/appendix/errors。 |
http_url | string | 触发错误的 URL。可能是你请求接口时使用的 URL,也可能是 pingback/postback 回调地址。 |
http_method | string | HTTP 请求方法。 |
http_code | integer | HTTP 状态码。 |
http_time | float | HTTP 请求耗时。对于设置了 pingback/postback 的任务,该字段表示你的服务器响应所耗费的时间。 |
http_response | string | 服务器响应。 |
请求示例
cURL
bash
curl --location --request POST "https://api.seermartech.cn/v3/domain_analytics/errors" \
--header "Authorization: Bearer smt_live_YOUR_KEY" \
--header "Content-Type: application/json" \
--data-raw '[
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]'Python
python
import requests
url = "https://api.seermartech.cn/v3/domain_analytics/errors"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
}
payload = [
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]
response = requests.post(url, headers=headers, json=payload)
print(response.json)TypeScript
typescript
import axios from "axios";
const postArray = [
{
limit: 10,
offset: 0,
filtered_function: "pingback_url"
}
];
axios({
method: "post",
url: "https://api.seermartech.cn/v3/domain_analytics/errors",
headers: {
Authorization: "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
},
data: postArray
})
.then((response) => {
// 输出返回结果
console.log(response.data);
})
.catch((error) => {
console.error(error);
});响应示例
json
{
"version": "0.1.20220321",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.1538 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"data": {
"api": "domain_analytics",
"function": "errors",
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
},
"result": []
}
]
}状态码说明
本接口的通用状态码与错误信息可参考:
/v3/appendix/errors
常见判断方式:
status_code = 20000:请求成功;- 状态码:表示请求参数、认证、额度或任务处理存在异常,需结合
status_message与tasks[].result中的错误排查。
使用建议
- 如需排查 webhook 异常,优使用
filtered_function过滤pingback_url或postback_url。 - 如需分批处理大量错误任务,建议合
limit与offset分页获取。 - 若要按时间窗口定位问题,可使用
datetime_from和datetime_to缩小排查范围。 - 若错误任务用于补发 webhook,可将返回的任务 ID 继续用于
/v3/appendix/webhook_resend/。
实用场景
- 排查回调失败任务:筛选
pingback_url或postback_url的错误记录,快速定位未成功送达的 webhook,减少数据漏接。 - 补发任务通知:获取错误任务 ID,再调用
/v3/appendix/webhook_resend/重发回调,保障下游系统的数据完整性。 - 定位服务端异常窗口:按
datetime_from、datetime_to过滤错误发生时间,判断是否存在某一时间段的集中障。 - 监控接口稳定性:按
function维度统计错误任务,识别哪类 Domain Analytics 功能调用最容易失败,优化调用策略。 - 审计失败请求细节:结合
http_code、http_time、http_response分析失败原因,提升任务调度与回调服务的稳定性。