我的API文档 / My API Documents

本页面列举了所有由我搭建的Web API服务，包括一些常用的网络服务，当前在线的服务列表：

目录

1. 对外发布使用的接口
   • 获取你的IP地址
     • v4(1) https://api.sharinghub.cn/ipv4
     • v4(2) https://ipv4.sharinghub.cn/
     • v6 https://ipv6.sharinghub.cn/
   • ping指定目标测试连通性
     • 1 https://api.sharinghub.cn/ping
     • 2 https://ping.sharinghub.cn/
   • frp开放服务端 https://api.sharinghub.cn/frps

接口明细

1. 对外接口

   1. 获取IPv4地址-1 https://api.sharinghub.cn/ipv4
      通过GET请求访问此接口，接口会返回请求所使用的IPv4地址和端口，添加?format=json参数可获得json格式的输出。

      输入参数	是否必需	默认值	说明
      format	否	text	可选json，其他参数或不提供参数即视为默认值

      示例：

      url	返回结果
      https://api.sharinghub.cn/ipv4	208.233.12.15:58566 (示例)
      https://api.sharinghub.cn/ipv4?format=json	{ "ip": "208.233.12.15", "port": 58566 } (示例)

   2. 获取IPv4地址-2 https://ipv4.sharinghub.cn/
      通过GET请求访问此接口，接口会返回请求所使用的IPv4地址。

      输入参数	是否必需	默认值	说明
      format	否	text

      示例：

      url	返回结果
      https://ipv4.sharinghub.cn	208.233.12.15 (示例)

   3. 获取IPv6地址 https://ipv6.sharinghub.cn/
      通过GET请求访问此接口，接口会返回请求所使用的IPv6地址。

      输入参数	是否必需	默认值	说明
      format	否	text	可选json，其他参数或不提供参数即视为默认值

      示例：

      url	返回结果
      https://ipv6.sharinghub.cn	2000:cf80::1 (示例)

   4. ping测试服务 https://api.sharinghub.cn/ping
      通过GET请求访问此接口，同时携带IP参数?ip=208.233.12.15(仅示例)，服务器会对目标执行ping操作并返回结果。

      输入参数	是否必须	默认值	说明
      ip	是	null	IP格式需要为点分十进制，不提供此参数会返回error

      输出参数	格式	说明
      host	<query.ip>	返回ping目标
      status	reachable|unreachable	返回状态，可达/不可达
      time	**ms	status为reachable时返回时延，unreachable时不返回此项
      error	Missing 'ip' query parameter.	仅在没有提供ip参数时返回

      示例：

      url	返回结果
      https://api.sharinghub.cn/ping	{"error":"Missing 'ip' query parameter."}
      https://api.sharinghub.cnping?ip=140.82.113.3	{"host":"140.82.113.3","status":"reachable","time":"200ms"} (示例)
      https://api.sharinghub.cnping?ip=59.24.3.174	{"host":"59.24.3.174","status":"unreachable"} (示例)

暂未完成，将继续更新……