API Key 与 IP 白名单

若当前实例开放业务 OpenAPI，客户可在自己的 Dashboard“API Key”页面管理访问密钥。这个 Key 用于客户的接口调用，不是代理连接凭据，也不是 Admin 运营账号的登录信息。入口是否可见以实例能力与当前账号为准。

创建和保管 Key

客户可按不同用途创建独立 Key，并设置有效期。完整 Key 只在创建成功时显示一次；列表中只显示掩码或前缀。创建后应立即保存到自己的安全配置中，不要放进聊天、工单、公开仓库或网页源码。忘记完整 Key 时，不能从列表找回；应按页面提供的管理操作创建新 Key，并在迁移调用方后停用或撤销旧 Key。

Key 可能处于使用中、已停用或已过期等状态。停用后可按页面操作重新启用；撤销不可恢复，依赖该 Key 的接口调用会停止。排查前先确认客户正在使用哪一个 Key，不要让客户把完整值发给客服。

白名单的范围和格式

“OpenAPI IP 白名单”是当前客户账号下全部 API Key 共用的来源限制，不是给某一个 Key 单独设置。启用后，OpenAPI 请求必须从已保存的可信出口 IP 发出。这里仅接受精确 IPv4 地址，不接受 CIDR 网段、IPv6 或带端口的地址；启用时列表不能为空。保存名单会整体替换原列表，删除已有地址前要确认其他调用方是否仍在使用。

客户应填写接口调用实际使用的出口公网 IP，而不是个人电脑的内网地址。若通过服务器、NAT 或代理发请求，应由客户自己的技术人员核对真实出口；更换出口后也要同步检查白名单。关闭白名单只改变来源限制，不会自动修复已过期或已停用的 Key。

接口调用失败的排查顺序

1. 确认当前实例支持业务 OpenAPI、客户已登录正确账号，且调用的接口属于已开放范围。
2. 在客户 Dashboard 核对 Key 状态和有效期；确认调用方已更新到当前使用的 Key。
3. 查看白名单是否启用，并核对请求实际出口 IPv4 是否在当前保存的完整列表中。
4. 仍失败时，收集发生时间、请求路径、错误码和脱敏后的请求信息，交给有权限的技术人员核对。不要收集完整 Key、代理密码或登录令牌。

账号与入口的其他问题见常见问题：账号与使用入口。