API 文档

访问我们的 RESTful API,将 IPv6 网络诊断工具集成到您的应用程序中。所有端点都返回 JSON 响应,支持 IPv4 和 IPv6。

基础 URL

Bash

https://ping6.net/api/v1

仅限 HTTPS

所有 API 请求必须使用 HTTPS 进行安全通信。

CORS 已启用

支持来自任何域的跨域请求。

身份验证

大多数端点无需身份验证即可使用。如需更高的速率限制和访问高级功能,请使用 API 密钥。

匿名

无需身份验证。受较低速率限制约束。

API 密钥

在 X-API-Key 标头中包含您的 API 密钥以获取更高的速率限制。

Bash

curl -X GET "https://ping6.net/api/v1/ping/google.com" \
  -H "X-API-Key: your-api-key-here"

速率限制

API 请求受速率限制,以确保公平使用和服务可用性。

层级	请求	备注
匿名	100 / minute	基于 IP 的限制。同一 IP 的所有匿名用户共享。
API 密钥	1,000 / minute	每个 API 密钥。联系我们获取更高限制。

速率限制标头

X-RateLimit-Limit每个窗口允许的最大请求数

X-RateLimit-Remaining当前窗口剩余请求数

X-RateLimit-Reset速率限制重置的 Unix 时间戳

错误处理

API 使用传统的 HTTP 响应代码来表示成功或失败。

代码	状态	描述
400	Bad Request	无效的请求参数或格式错误的请求体。
401	Unauthorized	受保护端点的 API 密钥无效或缺失。
404	Not Found	请求的资源或端点不存在。
429	Too Many Requests	超出速率限制。请等待后再发送更多请求。
500	Internal Server Error	服务器错误。请稍后重试或联系支持。

JSON

{
  "error": {
    "code": "INVALID_ADDRESS",
    "message": "The provided address is not a valid IPv6 address",
    "details": {
      "address": "invalid-address"
    }
  }
}

API 端点

GET/myip

获取我的 IP 地址

返回发出请求的客户端的公共 IP 地址。自动检测连接是 IPv4 还是 IPv6。

Example Response

JSON

{
  "ip": "2001:db8:85a3::8a2e:370:7334",
  "version": 6,
  "isIPv6": true
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/myip" \
  -H "Accept: application/json"

GET/validate

验证 IPv6 地址

验证 IPv6 地址并返回有关其格式、类型和规范表示的详细信息。

Parameters

Name	Type	In	Description
`address`*	string	query	要验证的 IPv6 地址

Example Response

JSON

{
  "valid": true,
  "type": "Documentation",
  "compressed": "2001:db8::1",
  "expanded": "2001:0db8:0000:0000:0000:0000:0000:0001"
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/validate?address=2001:db8::1" \
  -H "Accept: application/json"

GET/dns/{hostname}

DNS 查询

使用可配置的 DNS 解析器查询主机名的 DNS 记录。支持所有常见记录类型,特别关注 IPv6 的 AAAA 记录。

Parameters

Name	Type	In	Description
`hostname`*	string	path	要查询的主机名
`type`	enum: AAAA \| A \| MX \| TXT \| NS \| CNAME \| SOA \| PTR	query	要查询的 DNS 记录类型(default: `AAAA`)
`resolver`	enum: cloudflare \| google \| quad9	query	用于查询的 DNS 解析器(default: `cloudflare`)

Example Response

JSON

{
  "hostname": "google.com",
  "records": [
    {
      "type": "AAAA",
      "value": "2607:f8b0:4004:800::200e",
      "ttl": 300
    }
  ],
  "resolver": "cloudflare",
  "queryTime": 23
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/dns/google.com?type=AAAA&resolver=cloudflare" \
  -H "Accept: application/json"

GET/ping/{target}Beta

Ping 目标

向 IPv6 地址或主机名发送 ICMP 回显请求并接收延迟统计信息。需要 API 密钥身份验证。

Parameters

Name	Type	In	Description
`target`*	string	path	要 ping 的 IPv6 地址或主机名
`count`	string	query	要发送的 ping 数据包数量(1-10)(default: `4`)

Example Response

JSON

{
  "target": "2001:4860:4860::8888",
  "ip": "2001:4860:4860::8888",
  "results": [
    {
      "seq": 1,
      "ttl": 117,
      "rtt": 12.4
    },
    {
      "seq": 2,
      "ttl": 117,
      "rtt": 11.8
    },
    {
      "seq": 3,
      "ttl": 117,
      "rtt": 12.1
    },
    {
      "seq": 4,
      "ttl": 117,
      "rtt": 11.9
    }
  ],
  "stats": {
    "transmitted": 4,
    "received": 4,
    "loss": 0,
    "min": 11.8,
    "avg": 12.05,
    "max": 12.4
  }
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/ping/2001:4860:4860::8888?count=4" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"

GET/traceroute/{target}Beta

路由追踪

追踪到目的地的网络路径,显示沿途每个跳点的延迟信息。需要 API 密钥身份验证。

Parameters

Name	Type	In	Description
`target`*	string	path	要追踪的 IPv6 地址或主机名
`maxHops`	string	query	要追踪的最大跳数(1-64)(default: `30`)

Example Response

JSON

{
  "target": "google.com",
  "ip": "2607:f8b0:4004:800::200e",
  "hops": [
    {
      "hop": 1,
      "ip": "2001:db8::1",
      "hostname": "router.local",
      "rtt": 1.2
    },
    {
      "hop": 2,
      "ip": "2001:db8:1::1",
      "hostname": "isp-gateway.net",
      "rtt": 5.4
    },
    {
      "hop": 3,
      "ip": "2607:f8b0:4004:800::200e",
      "hostname": "google.com",
      "rtt": 12.8
    }
  ]
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/traceroute/google.com?maxHops=30" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"