隧道代理IP设置白名单API接口文档

API接口 / 隧道代理IP / 设置白名单

隧道代理IP · 设置白名单

推荐阅读时长：3分钟

设置指定订单或当前用户全部有效隧道订单的访问白名单。新白名单会替换原列表，不是追加。

项目	内容
请求方式	POST
接口路径	`/api/v1/tunnel/setWip`
Authorization	`Bearer YOUR_TOKEN`（替换为登录后取得的Token）
Content-Type	`application/json`
Accept	`application/json`

鉴权配置见鉴权方式。以下均为说明性示例，未执行真实业务请求；示例订单号、账号及密码均为占位值。

参数	类型	必填	说明
`orderNo`	string	是	type=one时指定订单；type=all时仍须传入非空订单号通过校验，但不会以该字段筛选订单。
`type`	string	否	one：指定有效隧道订单；all：当前用户全部有效隧道订单。默认one。
`wip`	string[]	是	非空IP字符串数组。当前只接受IPv4；无效IP、IPv6、空字符串及127.0.0.1会被过滤，去重后仅保留前50个。

注意：原始wip必须通过必填数组校验。非空数组在过滤后允许为空，这会清空白名单。请在客户端先检查IPv4格式；不要依赖错误数据来清空白名单。

{
  "orderNo": "TUN_EXAMPLE_001",
  "type": "one",
  "wip": [
    "203.0.113.10",
    "198.51.100.20"
  ]
}

{
  "orderNo": "TUN_EXAMPLE_001",
  "type": "all",
  "wip": [
    "203.0.113.10"
  ]
}

{
  "code": 200,
  "msg": "白名单设置成功",
  "data": []
}

{
  "code": 400,
  "msg": "白名单设置失败",
  "data": []
}

使用本人订单号及实际需要授权的公网IPv4替换示例。返回成功不包含匹配订单数量，也不能作为节点健康检测结果。