首页 > API 文档 > 白名单接口

白名单接口

白名单里放的是你调用方的出口 IP（服务器公网 IP 或办公室出口 IP），不是代理 IP。加进白名单后，请求代理可以不带账号密码，链路更短、更稳定。所有白名单接口同样需要有效的 OrderNumber。

接口一览

操作action参数返回
添加白名单addwhite（或 addwhiteip）OrderNumber、ip（可省略，省略时把当前请求的出口 IP 加进去）{"code":0,"success":true,"msg":"..."}
查询白名单getwhitesOrderNumber{"code":0,"success":true,"data":[{"AddTime":"...","UpdateTime":"...","IP":"1.2.3.4"}]}
删除白名单deletewhiteOrderNumber、ip（必填，IPv4 格式；传 all 表示清空）{"code":0,"success":true,"msg":"..."}

添加白名单

http://api.xydaili.net:2022/tools/ip.ashx?action=addwhite&OrderNumber=你的订单号&ip=203.0.113.10

也可以不传 ip，由服务器自己请求，接口会把这次请求的出口 IP 加进白名单：

# 在你的服务器上执行，把本机出口 IP 加进白名单
curl "http://api.xydaili.net:2022/tools/ip.ashx?action=addwhite&OrderNumber=你的订单号"

查询白名单

http://api.xydaili.net:2022/tools/ip.ashx?action=getwhites&OrderNumber=你的订单号

返回示例：

{"code":0,"success":true,"msg":"成功","data":[
  {"AddTime":"2026-09-20 10:12:03","UpdateTime":"2026-09-25 09:31:10","IP":"203.0.113.10"}
]}

删除白名单

http://api.xydaili.net:2022/tools/ip.ashx?action=deletewhite&OrderNumber=你的订单号&ip=203.0.113.10

删除单个 IP 用 ip=IPv4地址；要清空该订单的全部白名单，把 ip 传成 all：

http://api.xydaili.net:2022/tools/ip.ashx?action=deletewhite&OrderNumber=你的订单号&ip=all
清空操作会同时从上游池移除该订单的全部白名单，并同步清空本地记录，不可撤销，之后需要重新添加——建议只在换服务器或白名单被占满时使用。删除单个 IP 时，如果该 IP 刚添加不久（还在"使用中"），接口会返回 code=3 并提示需要等待的秒数。

返回码说明

code含义处理建议
0成功（删除单个 / 清空全部）—
1IP 格式不合法检查是否传了合法的 IPv4（如 203.0.113.10），不要传域名或 IPv6
2该 IP 不存在或已被删除先用 getwhites 确认当前列表
3该 IP 正在使用，暂时不能删除等返回提示的秒数后再试
4添加重复白名单过快同一个 IP 添加有间隔限制（60 秒），按提示秒数后重试

注意：白名单接口返回的是 code/success/msg；而提取接口返回的是 status（如 200），两套编号不要混用。提取时如果因为白名单已满被拒，会返回 status=203，详见 状态码对照表。

注意事项

  • 白名单有数量上限，上限由你购买的套餐决定（套餐页「默认白名单数量」）。加满后新 IP 加不进去，提取时也可能提示"白名单列表已满"，需要先删除不用的 IP。
  • 白名单是调用方出口 IP：如果服务器走 NAT、出口 IP 会变（例如多台机器负载均衡），建议给每台机器的出口 IP 都加上。
  • 添加有间隔限制，脚本里不要循环调用同一个 IP；建议在启动时检查一次 getwhites，缺了再加。
  • 想同时在多台设备上用（笔记本 + 服务器），更灵活的方式是账号密码授权，见 提取接口 返回里的 userName/pwd 字段。

相关文档