调用服务器对指定网址进行多ping,获取网址的CDN的IP地址,CDN的IP服务商及大概地理位置,响应最短、最长及平均时间,丢包率及耗时。(由于获取的数据太多,响应可能会比较慢)
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| key | string | 是 | 接口调用密钥 | |
| url | string | 是 | 需要检测的域名,可以不需要带HTTP/HTTPS | api.317ak.com |
| type | string | 否 | 以填写text/json/text1,如果不写则默认json | json |
[
{
"name": "key",
"type": "string",
"required": true,
"description": "接口调用密钥",
"example": ""
},
{
"name": "url",
"type": "string",
"required": true,
"description": "需要检测的域名,可以不需要带HTTP/HTTPS",
"example": "api.317ak.com"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "以填写text/json/text1,如果不写则默认json",
"example": "json"
}
]
{
"openapi": "3.1.1",
"info": {
"title": "聚合ping",
"description": "调用服务器对指定网址进行多ping,获取网址的CDN的IP地址,CDN的IP服务商及大概地理位置,响应最短、最长及平均时间,丢包率及耗时。(由于获取的数据太多,响应可能会比较慢)",
"version": "1.0.0"
},
"paths": {
"/api/zzgj/jhping/api.php": {
"get": {
"summary": "聚合ping",
"description": "调用服务器对指定网址进行多ping,获取网址的CDN的IP地址,CDN的IP服务商及大概地理位置,响应最短、最长及平均时间,丢包率及耗时。(由于获取的数据太多,响应可能会比较慢)",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "url",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "api.317ak.com"
},
"description": "需要检测的域名,可以不需要带HTTP/HTTPS"
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "json"
},
"description": "以填写text/json/text1,如果不写则默认json"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"post": {
"summary": "聚合ping",
"description": "调用服务器对指定网址进行多ping,获取网址的CDN的IP地址,CDN的IP服务商及大概地理位置,响应最短、最长及平均时间,丢包率及耗时。(由于获取的数据太多,响应可能会比较慢)",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "url",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "api.317ak.com"
},
"description": "需要检测的域名,可以不需要带HTTP/HTTPS"
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "json"
},
"description": "以填写text/json/text1,如果不写则默认json"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api-v2.317ak.com",
"description": "当前访问入口(https)"
}
]
}
{
"状态": "成功",
"域名": "api.317ak.com",
"速度测试": {
"最小延迟": "26.92ms",
"平均延迟": "29.37ms",
"最大延迟": "34.60ms",
"数据包数": 5,
"接收数据包": 5,
"丢包率": "0%",
"总耗时": "146.60ms",
"HTTP状态码": 200,
"状态": "正常"
},
"IP列表": [
{
"IP类型": "IPv4",
"IP地址": "114.66.44.99",
"IP信息": {
"IP地区": "中国",
"IP省份": "北京",
"IP运营商": "中国电信"
}
}
]
}
提供网址网络连通性与访问速度检测服务,可获取目标网址的响应情况及相关网络信息。适用于站长、运维人员等对网站访问质量进行分析与监测。
https://api-v2.317ak.com/api/zzgj/jhping/api.php
GET、POST
本接口需要密钥鉴权,请在请求地址中通过 Query 参数传递:
key=接口调用密钥
调用时需携带有效密钥,否则无法使用接口服务。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 接口调用密钥,通过 Query 参数传递,参数格式为 key=… |
| url | string | 是 | 需要检测的域名,可以不需要带 HTTP/HTTPS 前缀 |
| type | string | 否 | 返回格式设置,可填写 text、json、text1;不填写时默认返回 json 格式 |
{
"状态": "成功",
"域名": "api.317ak.com",
"速度测试": {
"最小延迟": "26.92ms",
"平均延迟": "29.37ms",
"最大延迟": "34.60ms",
"数据包数": 5,
"接收数据包": 5,
"丢包率": "0%",
"总耗时": "146.60ms",
"HTTP状态码": 200,
"状态": "正常"
},
"IP列表": [
{
"IP类型": "IPv4",
"IP地址": "114.66.44.99",
"IP信息": {
"IP地区": "中国",
"IP省份": "北京",
"IP运营商": "中国电信"
}
}
]
}
| 字段 | 类型 | 说明 |
|---|---|---|
| 状态 | string | 请求处理状态 |
| 域名 | string | 检测的目标域名 |
| 速度测试 | object | 网址多次检测的速度统计信息 |
| 速度测试.最小延迟 | string | 检测中的最低响应延迟 |
| 速度测试.平均延迟 | string | 检测中的平均响应延迟 |
| 速度测试.最大延迟 | string | 检测中的最高响应延迟 |
| 速度测试.数据包数 | number | 检测发送的数据包数量 |
| 速度测试.接收数据包 | number | 成功接收的数据包数量 |
| 速度测试.丢包率 | string | 检测过程中的数据包丢失比例 |
| 速度测试.总耗时 | string | 本次检测总耗时 |
| 速度测试.HTTP状态码 | number | 目标网址返回的 HTTP 状态码 |
| 速度测试.状态 | string | 目标网址当前状态描述 |
| IP列表 | array | 检测到的 IP 信息列表 |
| IP列表.IP类型 | string | IP 地址类型 |
| IP列表.IP地址 | string | 检测到的 IP 地址 |
| IP列表.IP信息 | object | IP 地理及服务信息 |
| IP列表.IP信息.IP地区 | string | IP 所属地区 |
| IP列表.IP信息.IP省份 | string | IP 所属省份或区域 |
| IP列表.IP信息.IP运营商 | string | IP 服务提供商信息 |
接口发生业务异常时,返回统一 JSON 格式:
{"code":0,"msg":"未提供调用密钥","errcode":11001}
| errcode | 含义 |
|---|---|
| 11001 | 未提供调用密钥 |
| 11002 | 密钥错误 |
| 11003 | 密钥已禁用 |
| 11004 | 积分余额不足 |
| 11005 | 请求过于频繁(QPM 限制) |
| 11006 | 接口维护中 |
| 11007 | 接口已禁用 |
| 11008 | 接口不可用 |
| 11009 | 密钥校验暂不可用 |
| 11010 | 积分系统暂不可用 |
| 11011 | 收费接口须提供有效密钥 |
| 11012 | 鉴权方式错误 |
| 11013 | 接口不存在 |
| 11014 | ***地址无效 |
| 11015 | ***地址不允许 |
| 11016 | ***请求失败 |
| 11017 | 服务暂不可用 |
| 11018 | 请求方式不允许 |
| 11019 | 当前IP不在白名单内 |
| 11020 | 启用出口代理须提供有效密钥 |
| 11021 | 未配置可用出口代理 |
| 11022 | 出口代理不可用 |
| 11023 | 密钥已过期 |
| 11024 | 令牌分配积分不足 |
curl -G "https://api-v2.317ak.com/api/zzgj/jhping/api.php" \
--data-urlencode "key=你的密钥" \
--data-urlencode "url=api.317ak.com" \
--data-urlencode "type=json"
// PHP
## 注意事项
- 调用接口前请妥善保管接口调用密钥,避免将密钥公开发布、提交到公开代码仓库或直接暴露在前端页面中。
- 本接口必须通过 Query 参数传递密钥,格式为 `key=接口调用密钥`。请确保请求中携带有效密钥,否则无法正常调用。
- 检测目标参数 `url` 为必填项,可填写域名格式,例如 `api.317ak.com`。建议填写有效可访问的域名,避免因目标地址错误导致检测失败。
- `url` 参数可不携带 HTTP/HTTPS 前缀,提交前请确认域名拼写正确。
- `type` 参数为可选项,可填写 `text`、`json` 或 `text1`,未填写时默认返回 JSON 格式数据。
- 本接口会进行多次网络检测并返回延迟、丢包率、IP信息等结果,由于需要处理的数据较多,接口响应时间可能较长,请合理设置客户端等待时间。
- 请勿在短时间内高频重复请求同一目标,避免影响接口稳定性。批量检测时建议控制调用频率。
- 建议使用 HTTPS 方式调用接口,确保请求过程中的数据传输安全。
- 检测结果中的延迟、丢包率等数据会受到网络环境影响,结果仅用于网络状态分析参考。curl -G \
'https://api-v2.317ak.com/api/zzgj/jhping/api.php' \
--data-urlencode 'key=YOUR_API_KEY' \
--data-urlencode 'url=api.317ak.com' \
--data-urlencode 'type=json'
# 调用成功后返回结果
# url填写检测域名
# key替换为接口密钥