IP 归属地库 geoip

主控在用的 IP 归属地库(服务商下发 > 内置)、节点对齐进度与地址查询。

点击任一接口,右侧显示对应的调用示例。

运维与系统鉴权: 仅管理员2 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/geoip/lookup查询 IP 归属地

鉴权: 仅管理员

查询参数

字段类型说明
ip必填string IPv4 或 IPv6 地址。

IP 归属地库对象

字段类型说明
activeGeoipActive 当前下发给节点的库与各级来源状态;sha256 为空表示还没核出(节点用包里的内置库)。
countrystring 国家/地区编号(ISO 3166-1 两位大写),没有为空。
coverageGeoipCoverage 免费版与商业版的覆盖率对比,由授权带下来;哪一侧没有统计就省略哪一侧(页面显示「—」),与有没有开通商业版无关。
foundboolean 库里有这个地址(至少一个字段有值)。
ipstring 查询的地址。
ispstring 运营商编号,没有为空。
nodesGeoipNodes 节点对齐进度(按心跳回报的在用库)。
provstring 省份编号(只有中国大陆),没有为空。
region_enabledboolean 恒为 true:省份/运营商对免费版同样开放,字段留给老前端。
sourcestring 在用库来源:provider 服务商下发、builtin 内置。
可选值 ["provider","builtin"]
tierstring 当前下发给节点的档位:biz 服务商下发的商业库,free 内置免费版。
可选值 ["free","biz"]
versionstring 在用库版本。

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令