API 密钥

Ultralytics Platform API 密钥支持安全的程序化访问，用于远程训练、推理和自动化。您可以创建具有特定权限的范围密钥，以满足不同的用例需求。

创建 AP 密钥

创建新的 API 密钥：

1. 前往 设置 > API 密钥
2. 点击 创建密钥
3. 输入密钥名称
4. 选择权限范围
5. 点击 创建

密钥名称

为您的密钥指定一个描述性名称：

• training-server - 适用于远程训练机器
• ci-pipeline - 适用于 CI/CD 集成
• mobile-app - 适用于移动应用程序

权限范围

选择范围以限制密钥权限：

密钥显示

创建后，密钥将显示一次：

密钥格式

API 密钥遵循以下格式：

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• 前缀: ul_ 用于识别 Ultralytics 密钥
• 主体：40 个随机十六进制字符
• 总计：43 个字符

使用 API 密钥

环境变量

将您的密钥设置为环境变量：

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

代码中

在您的python脚本中使用此密钥：

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "ul_your_key_here"

HTTP 请求头

在API请求中包含此密钥：

curl -H "Authorization: Bearer ul_your_key_here" \
  https://platform.ultralytics.com/api/...

远程训练

使用您的密钥启用指标流传输。

pip install "ultralytics>=8.4.0"

export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

管理密钥

查看密钥

所有密钥均列在“设置”>“API 密钥”中：

撤销密钥

撤销已泄露或不再需要的密钥：

1. 点击密钥菜单
2. 选择撤销
3. 确认撤销

重新生成密钥

如果密钥已泄露：

1. 创建具有相同作用域的新密钥
2. 更新您的应用程序
3. 撤销旧密钥

安全最佳实践

应做

• 将密钥存储在环境变量中
• 为不同环境使用单独的密钥
• 及时撤销未使用的密钥
• 使用最小必需范围
• 定期轮换密钥

不应做

• 将密钥提交到版本控制
• 在应用程序之间共享密钥
• 不必要地使用管理员范围
• 在应用程序输出中记录密钥
• 将密钥嵌入客户端代码

密钥轮换

为安全起见，定期轮换密钥：

1. 创建具有相同范围的新密钥
2. 更新应用程序以使用新密钥
3. 验证应用程序是否正常工作
4. 撤销旧密钥

故障排除

无效密钥错误

Error: Invalid API key

解决方案：

1. 验证密钥是否正确复制
2. 检查密钥是否未被撤销
3. 确保密钥具有所需范围
4. 确认环境变量已设置

权限拒绝

Error: Permission denied for this operation

解决方案：

1. 检查密钥范围是否包含所需权限
2. 验证您是资源所有者
3. 创建具有正确范围的新密钥

速率限制

Error: Rate limit exceeded

解决方案：

1. 降低请求频率
2. 实现指数退避
3. 联系支持以提高限制

常见问题

我可以创建多少个密钥？

API 密钥没有硬性限制。您可以根据不同的应用程序和环境需求创建任意数量的密钥。

密钥会过期吗？

密钥不会自动过期。它们在被撤销之前始终有效。为安全起见，请考虑实施轮换机制。

创建后我能看到我的密钥吗？

不，完整的密钥仅在创建时显示一次。如果丢失，请创建新密钥并撤销旧密钥。

密钥是区域特定的吗？

密钥可在不同区域使用，但只能访问您账户所在区域的数据。

我可以与团队成员共享密钥吗？

最佳实践：让每个团队成员创建自己的密钥。这可以实现：

• 个人活动跟踪
• 选择性撤销
• 适当的访问控制

📅 创建于 20 天前 ✏️ 更新于 19 天前

评论