开放API接口文档_TCPTest
TCPTest开放API:通过 HTTP 接口从多地检测节点发起 Ping、TCPing、网站测速和 DNS 查询,异步获取每个节点的检测结果。使用 API Key 鉴权,按成功执行的节点计费,查询节点、额度和结果免费。
接口地址与鉴权
开放 API 的所有接口都在本站的 /api/open/v1 路径下,请求体和回答都是 JSON。每次调用都要在请求头里带上 API Key:Authorization: Bearer <API Key>。API Key 以 px_ 开头,由会员在会员中心的「我的 API Key」创建。
检测类型
- Ping(type 为
ping):从所选节点向目标发送 ICMP 回显请求(ping),测量往返延迟和丢包。每个节点按 count 发送若干轮,每轮 1 个包、返回一条结果;节点的最后一条结果(final=true)带整次汇总。 - TCPing(type 为
tcping):从所选节点向目标端口发起 TCP 连接,测量建立连接的耗时。每个节点按 count 连接若干轮,每轮返回一条结果;节点的最后一条结果(final=true)带整次汇总。 - 网站测速(type 为
http):从所选节点用 GET 请求目标网址,测量 DNS 解析、TCP 连接、TLS 握手、首字节和内容传输各阶段的耗时,并返回状态码和响应头。每个节点返回一条结果。收到响应并读完响应内容就算这个节点执行成功,不论状态码是多少(包括 4xx、5xx);网站是否正常请看 status。 - DNS(type 为
dns):从所选节点用节点自己的 DNS 解析器查询目标的记录,返回解析结果和耗时。每个节点返回一条结果。
接口列表
GET /api/open/v1/nodes:获取节点列表(免费)GET /api/open/v1/quota:查询可用额度(免费)POST /api/open/v1/tasks:创建检测任务(按成功执行的节点扣额度)GET /api/open/v1/tasks/{id}:查询任务进度(免费)GET /api/open/v1/tasks/{id}/results:获取检测结果(免费)POST /api/open/v1/icp:查询 ICP 备案(每次成功查询扣 1 次额度)
计费规则
创建任务时按参与的节点预占额度,任务结束后只扣成功执行的节点:1 个成功节点扣 1 次额度,其余退回。备案查询每次成功查询扣 1 次额度(查不到备案也算成功),查询失败不扣。查询节点、额度、任务进度和结果都不扣额度。开放 API 与定时拨测共用套餐额度。