主题
API 状态
接口说明
通过本接口可获取当前所有 API 与各端点的运行状态信息;若存在异常,还会返回对应的问题描述,便于监控、告警与障排查。
请求频率限制: 每分钟最多 10 次请求。 历史状态范围: 可查看最近 60 天的 API 状态信息(参考文档)。 计费说明: 本接口,不会产生费用;扣费以响应头 X-SeerMarTech-Charge-CNY 为准。
请求方式
GET https://api.seermartech.cn/v3/appendix/status
响应为 JSON,顶层 tasks 数组每个任务返回一次状态获取结果。
顶层响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
version | string | 当前 API 版本 |
status_code | integer | 通用状态码 |
status_message | string | 通用状态信息 |
time | string | 总执行时间,单位秒 |
cost | float | 本次请求总费用,单位 USD |
tasks_count | integer | tasks 数组中的任务数 |
tasks_error | integer | tasks 数组中返回错误的任务数 |
tasks | array | 任务结果数组 |
状态码与通用信息列表可参考
/v3/appendix/errors。 建议在接时实现完善的异常处理与错误重试机制。
tasks 数组字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 任务唯一标识,UUID 格式 |
status_code | integer | 任务状态码,范围通常为 10000-60000 |
status_message | string | 任务状态信息 |
time | string | 任务执行时间,单位秒 |
cost | float | 该任务费用,单位 USD |
result_count | integer | result 数组中的数量 |
path | array | 请求路径 |
data | array | GET 请求 URL 中传递的参数 |
result | array | 结果数组 |
result 数组字段
每个 result素表示一个 API 的当前可用状态。
| 字段 | 类型 | 说明 |
|---|---|---|
api | string | API 名称 |
status | string | 当前状态 |
endpoints | array | 端点状态数组 |
api 可选值
serpkeywords_dataappendixdataforseo_labsdomain_analyticsmerchanton_pagebusiness_databacklinksapp_datacontent_analysiscontent_generation
status 可选值
major_outage:重大障partial_outage:部分障long_response_time:响应时间过长long_execution_time:执行时间过长webhook_delay:Webhook 延迟send_delay:发送延迟
endpoints 数组字段
endpoints 中的每个对象描述某个端点的当前状态。
| 字段 | 类型 | 说明 |
|---|---|---|
endpoint | string | 端点名称 |
status | string | 该端点当前状态 |
endpoint 可选值
task_gettask_postlivepostback/pingback
端点状态可选值
major_outagepartial_outagelong_response_timelong_execution_timewebhook_delaysend_delay
调用示例
cURL
bash
curl --location --request GET "https://api.seermartech.cn/v3/appendix/status" \
--header "Authorization: Bearer smt_live_YOUR_KEY" \
--header "Content-Type: application/json"Python
python
import requests
url = "https://api.seermartech.cn/v3/appendix/status"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
result = response.json
# 建议检查业务状态码
if result.get("status_code") == 20000:
print(result)
else:
print(f"error. Code: {result.get('status_code')} Message: {result.get('status_message')}")TypeScript
typescript
import axios from "axios";
axios({
method: "get",
url: "https://api.seermartech.cn/v3/appendix/status",
headers: {
Authorization: "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json",
},
})
.then((response) => {
const result = response.data;
// 返回结果
console.log(result);
})
.catch((error) => {
console.error(error);
});响应示例
json
{
"version": "0.1.20220819",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.1054 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "7b4f1c2e-3f7d-4b46-9c0c-1234567890ab",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0321 sec.",
"cost": 0,
"result_count": 12,
"path": [
"v3",
"appendix",
"status"
],
"data": {
"api": "appendix",
"function": "status"
},
"result": [
{
"api": "serp",
"status": "ok",
"endpoints": []
},
{
"api": "keywords_data",
"status": "ok",
"endpoints": []
},
{
"api": "appendix",
"status": "ok",
"endpoints": null
},
{
"api": "dataforseo_labs",
"status": "ok",
"endpoints": []
},
{
"api": "domain_analytics",
"status": "ok",
"endpoints": []
},
{
"api": "merchant",
"status": "ok",
"endpoints": []
},
{
"api": "on_page",
"status": "ok",
"endpoints": []
},
{
"api": "business_data",
"status": "ok",
"endpoints": []
},
{
"api": "backlinks",
"status": "ok",
"endpoints": []
},
{
"api": "app_data",
"status": "ok",
"endpoints": []
},
{
"api": "content_analysis",
"status": "ok",
"endpoints": []
},
{
"api": "content_generation",
"status": "ok",
"endpoints": []
}
]
}
]
}状态码说明
- 顶层
status_code:表示整个请求的处理结果 - 任务级
tasks[].status_code:表示单个任务的处理结果 - 若返回非成功状态,建议结合:
status_codestatus_messagetasks_errortasks[].status_message
一并进行告警与重试判断
完整错误码与提示信息可参考 /v3/appendix/errors。
使用建议
- 在批量调度任务前,检查 API 是否存在
major_outage或partial_outage - 如果某个 API 状态为
long_response_time或long_execution_time,建议适当延长时时间 - 若依赖回调机制,出现
webhook_delay或send_delay时,应增加结果轮询或补偿逻辑 - 建议将该接口接监控系统,定时采集状态并生成告警
实用场景
- 监控接口健康度:定时拉取各 API 与端点状态,及时发现障或性能下降,减少业务中断风险。
- 控制任务投放节奏:在
partial_outage或long_execution_time时自动降低任务提交频率,请求堆积和时。 - 切换结果获取策略:当出现
webhook_delay时,从回调模式切换为主动轮询,提高结果获取稳定性。 - 障排查:将状态接口返回结果与调用失败日志,快速判断问题来自本地系统还是平台 API。
- 优化调度与告警:根据不同 API 的实时状态,动态调整采集优级,优保障核心 SEO 数据任务执行。