概述
IP 允许列表是一项可选的安全功能,可用于限制哪些 IP 地址能够访问你的 OpenAI API。
启用后,仅允许来自已配置的 IP 地址或 IP 地址段的请求。来自所有其他 IP 的请求都会被拒绝,即使请求包含有效的 API 密钥。
此功能仅允许受信任的网络环境访问 API,旨在帮助降低未经授权使用 API 的风险。
注意:IP 允许列表仅适用于 API 请求。它不会影响对 platform.openai.com 的访问或用户登录。
为什么使用 IP 允许列表
IP 允许列表可以帮助你:
将 API 访问限制在已知的基础设施范围内(例如你的服务器或云环境)
降低 API 密钥泄露时面临的风险
为 API 流量来源增加一层管控
IP 允许列表最常用于 API 流量来自固定或明确界定的网络地址段的生产环境。
工作原理
你可以配置一个列表,列出允许访问的 IP 地址或 CIDR 地址段。
来自允许列表中 IP 的请求会被接受。
来自允许列表以外 IP 的请求会被拒绝。
IP 允许列表可应用于:
组织级别,或
项目级别
适用范围
所有 API 客户均可使用 IP 允许列表。
请按照以下步骤配置 IP 允许列表。
配置 IP 允许列表
注意:最多可添加 50 个 IP 地址或 CIDR 地址段。
打开设置。
选择安全。
选择 IP 允许列表。
添加一个或多个 IP 地址或 CIDR 地址段。
(可选)使用检查工具验证某个 IP 是否包含在允许列表中。
为以下范围启用允许列表:
特定项目,或
整个组织。
从预期使用的环境中发送请求进行测试。
建议先在单个项目中启用,再将其应用到整个组织。
更改后,更新最多可能需要 15 分钟才能生效。
注意:你必须具有相应的组织权限,才能配置 IP 允许列表设置。
问题排查
如果请求意外失败:
确认请求来自允许访问的 IP 地址。
检查基础设施的 IP 地址是否已更改。
检查已配置的 IP 地址段是否准确。
等待配置更改同步完成,这最多需要 15 分钟。
使用检查工具验证某个 IP 是否被允许访问。
请求被拦截时会发生什么
如果请求来自不在允许列表中的 IP 地址,请求将失败并返回:
HTTP 状态:401 Unauthorized
错误代码:ip_not_authorized
响应示例:
{
"error": {
"message": "Your IP is not authorized to access this organization.",
"type": "ip_not_authorized"
}
}
常见问题
IP 允许列表能防止我的 API 密钥被用于任何未经授权的用途吗?
不能。IP 允许列表可通过限制 API 请求的来源来帮助降低风险,但无法完全防止所有形式的滥用。应将其与其他安全最佳实践结合使用,例如安全存储密钥、轮换密钥,以及采取严格的账号安全措施。如需进一步提升安全性,请参阅帮助中心的API 密钥安全最佳实践和防止未经授权的使用指南。
IP 允许列表会影响延迟吗?
在某些情况下,IP 允许列表可能会增加极少量的延迟,通常出现在初始请求中。预计不会显著影响 API 的整体性能。
如何判断请求是否因 IP 允许列表而失败?
因 IP 允许列表而失败的请求会返回:
HTTP status: 401 UnauthorizedError code: ip_not_authorized
