跳转到内容
Local API代理管理

检测已保存代理 ​

版本概览
POST
/api/v1/proxies/{proxy_id}/check

检测当前用户、当前团队有权访问的已保存代理,支持 custom、api、integ、syt 四种模式,并更新该代理的 status 和 checked_at。同一代理的并发检测复用一个任务。API 代理会先按 auth_type 检测当前 endpoint;失败时重新访问提取地址,必要时保存新的 endpoint 后再检测。代理连接失败或提取失败均作为 status=unavailable 的正常检测结果返回。

请求参数

Authorization Bearer Token

在请求头 Authorization 中使用 Bearer Token 传入 API Key。

Authorization: Bearer <api-key>

Path 参数

1
字段说明
string必填
代理唯一标识
示例值"proxy_01JABCDEF1234567890"
minLength: 1

请求示例代码

JavaScript / TypeScript 使用 Node.js 18+ 内置 fetch;PHP 需启用 cURL 扩展;Go 需 1.16+;Java 需 JDK 11+。运行前请替换 Token 和示例参数值。

curl -X POST -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/check'

返回响应

成功时 code = 0,失败时 code > 0。选择状态码查看对应字段和示例,展开对象可查看嵌套字段;可选字段可能不返回。

已保存代理检测结果

Body

application/jsonProxySavedCheckSuccessResponse
字段说明
number必填
业务状态码;成功固定为 0
枚举值
string必填
业务状态信息;成功固定为 success
枚举值
object必填
接口业务数据

不允许额外字段。

示例

根据数据模型生成,非实际请求结果。

{
  "code": 0,
  "message": "success",
  "data": {
    "proxy_id": "proxy_01JABCDEF1234567890",
    "mode": "custom",
    "status": "available",
    "endpoint": {
      "protocol": "http",
      "ip_protocol": "ipv4",
      "host": "string",
      "port": 0
    },
    "checked_at": "2024-01-15T09:30:00Z",
    "latency_ms": 0
  }
}

查看全部业务错误码与 HTTP 状态码

中屹浏览器 Local API 文档