跳到正文
本中心目录
API 文档 · 动态 IP 功能

查询动态 IP 白名单

分页查看当前账户的动态 IP 来源白名单,可按状态或 IP 筛选。

只只HTTP技术团队维护更新于 2026年10月6日

接口与认证

GET/openapi/v1/proxy/whitelist/list

仅查询本人白名单,精确 IP 过滤。

使用 HTTPS;唯一非空 api_key Query,仅接受账户 API 令牌。

示例为合成数据与占位凭据,仅说明结构。接口合同不代表目标环境已开放,开放状态以控制台为准。

下载 OpenAPI · 导入 Apifox / Postman

请求参数

查询与路径参数
字段类型必填默认值 / 限制说明
api_keystring是Query · 唯一非空账户 API 令牌,在受控服务端保存;示例使用占位符。
pageinteger否query · 默认 1;最小 1页码,默认 1。
page_sizeinteger否query · 默认 20;最小 1;最大 100每页条数,默认 20,最大 100。
statusstring否query · 默认 all;枚举 all / active / disabled状态过滤。
ipstring否query · —来源 IP 精确筛选。

无请求体。

请求示例

Shell · STATIC_API_KEY 使用账户令牌
curl --request GET \
  "https://api.zzhttp.com/openapi/v1/proxy/whitelist/list?api_key=${API_KEY}"

成功响应

成功或逐项批量结果,请同时核对业务码。

响应不含内部字段或代理密码。提取 HTTP 200 / code 0 为成功;白名单及国家目录 code 200 为成功。POST 提取的错误使用 code/message 格式;国家目录成功响应没有 requestId。

响应字段(含嵌套字段)
字段类型必填默认值 / 限制说明
codeinteger是—成功为 200;白名单批量任一失败为 10431。
messagestring是—结果说明。
requestIdstring是—请求追踪 ID。
dataobject是—本接口业务数据。
data.itemsobject[]是—当前页本人白名单。
data.items[].whitelist_idinteger是最小 1白名单记录 ID。
data.items[].ipstring是—来源 IPv4 地址,精确匹配。
data.items[].remarkstring是—客户备注,最长 255 字符。
data.items[].statusinteger是枚举 1 / 31 启用,3 停用;已删除记录不返回。
data.items[].created_atstring是格式 date-time创建时间,RFC3339。
data.pageinteger是—页码,从 1 开始。
data.page_sizeinteger是—每页条数。
data.totalinteger是—筛选后的总记录数。
JSON · HTTP 200
{
  "code": 200,
  "message": "查询成功",
  "requestId": "demo-request-001",
  "data": {
    "items": [
      {
        "whitelist_id": 101,
        "ip": "203.0.113.10",
        "remark": "office",
        "status": 1,
        "created_at": "2026-10-06T08:00:00Z"
      }
    ],
    "page": 1,
    "page_size": 20,
    "total": 1
  }
}

错误与重试

每个令牌查询 60 次/分钟,添加或删除各 10 次/分钟。429 按 Retry-After 等待;写入结果不明先查询列表,仅重试未成功项。

错误码、HTTP 状态、错误响应字段及恢复方式统一见错误码与处理建议。

这篇内容解决了你的问题吗?

反馈只用于改进公开文档,不会提交账号或请求信息。