API 网关
API 网关
文档指南
请输入
- 文档首页
API 网关用户指南插件中心传输协议GEOIP 插件
复制全文
下载 pdfGEOIP 插件
文档反馈
问问助手GEOIP 插件支持根据用户源 IP 地址获取用户所在国家的代码，并添加到 Header 中，用于后续的业务开发。本文介绍如何创建 GEOIP 插件。
背景信息
GEOIP 插件是一种能够根据 IP 地址确定用户地理位置的工具。它基于 IP 地理定位技术，通过查询 IP 地理位置数据库，将 IP 地址映射为国家、城市、经纬度等地理信息。
前提条件
- 已创建网关实例，操作详情请参见 创建实例。
- 已创建 固定域名类型 Upstream，操作详情参见 创建固定域名 Upstream。域名为 IP 地理位置数据库文件所在 Bucket 的 TOS 域名，需要启用 HTTPS 协议，并将域名配置为 SNI。
- 已创建存储桶，操作详情参见 创建存储桶。
- 已上传存储 MaxMind IP 地理位置数据库，操作详情参见 上传文件。
- 已获取本账号的 AccessKey （AK）和 SecretKey（SK）。AK SK 支持在 访问控制 > API访问密钥 中获取。
操作步骤
- 登录 API 网关控制台。
- 在顶部导航栏，选择目标地域。
- 在左侧导航栏 实例管理 下拉框中选择目标实例后， 单击 插件中心 > 传输协议 > GeoIP 插件。
- 单击 创建插件， 配置插件规则。
- 配置项说明生效级别选择插件的生效级别，包括：
- 实例级别：插件在实例中生效，需要指定生效的目标实例。
- 服务级别：插件在服务内生效，需要指定生效的目标实例和目标服务。
- 路由级别：插件在路由内生效，需要指定生效的目标实例、目标服务和目标路由。
所属服务选择插件所属服务。所属路由选择插件所属路由。IP 获取方式支持以下 IP 获取方式。- 基于 X-Forward-For：从 HTTP 头获取客户端 IP，含代理层 IP，需结合信任代理配置。
- 基于自定义 Header 获取：需服务端约定头名，灵活但依赖双方规范。
- 基于 TCP 连接获取：从 TCP 连接直接取源 IP，不易篡改，准确性高，适用于无代理场景。
TOS 配置填写 IP 地址数据库所处 TOS 的配置信息。- AKSK 配置：填写您账号的 AccessKey （AK）和 SecretKey（SK）。
- Bucket：选择 IP 地址数据库所属的 TOS 存储桶。
- Object：填写 IP 地址数据库在存储桶中的文件名。
- 超时：自定义下载数据库超时时长，超时将下载失败。如果下载失败，插件将在开启后每 3600 秒触发重新下载。
- Upstream：选择已创建的固定域名 Upstream。
- 单击 确定，完成配置。
最近更新时间：2026.08.17 14:18:15
这个页面对您有帮助吗？
有用
有用
无用
无用