# IP 地理信息数据库

# 修改 IP 地理信息数据库

# 简介

修改 IP 地理信息数据库

# URI

PUT /admin-api/global/1/ip

# JSON body

{
  "token":"xxx-xxx-xxx-xxx", // only ipdb, maxmind and maxmind_lite need token
  "database_type": "maxmind_lite" // [ipdb, maxmind, maxmind_lite, qqzeng]
}

# 请求示例

# Shell

curl -X PUT \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://{admin-site}/admin-api/global/1/ip \
  -d $'{"token":"1df87165-3593-4eca-a910-9ac20005e6ec","database_type": "ipdb"}'

# 响应示例

Status: 200 OK
{"status":0}

# 上传 qqzeng IP 地理信息数据库

# 简介

上传 qqzeng IP 地理信息数据库,并会修改 IP 地理信息数据库类型为 qqzeng

# URI

POST /admin-api/ip_database/upload_qqzeng

# 请求示例

# Shell

curl -X POST \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://{admin-site}/admin-api/ip_database/upload_qqzeng -F "filename=@/path/qqzeng-ip-utf8.dat"

# 响应示例

Status: 200 OK

{"status":0,"time":1620793265,"data":"wait for qqzeng database processing to complete..."}

# 获取当前配置的 IP 地理信息数据库

# 简介

获取当前配置的 IP 地理信息数据库

# URI

GET /admin-api/ip_database/current

# 请求示例

# Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://{admin-site}/admin-api/ip_database/current

# 响应示例

Status: 200 OK

{"status":0,"time":1620793740,"data":{"database_type":"qqzeng","version":"7621aa9f75536d100b73fdc8910cfbd30f9ddbd8"}}

# 查找当前 IP 地理信息数据库的 meta 数据

# 简介

按照关键字查找当前数据库的 meta 数据 (目前只支持 qqzeng IP 地理信息数据库)

只能指定一种类型的 keyword

# URI

GET /admin-api/ip_database/meta

# URI parameter

  • country_keyword

    type: string

    required: no

    description: 国家/地区搜索关键字,不能和其他关键字参数同时使用

  • province_keyword

    type: string

    required: no

    description: 省份搜索关键字,不能和其他关键字参数同时使用

  • city_keyword

    type: integer

    required: no

    description: 城市搜索关键字,不能和其他关键字参数同时使用

# 请求示例

# Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://{admin-site}/admin-api/ip_database/current?country_keyword=Mala

# 响应示例

Status: 200 OK
{
    "data": {
        "database_type": "qqzeng",
        "meta": [
            [
                "Malaysia", // CountryEn
            ]
        ]
    },
    "time": 1620797549,
    "status": 0
}