API 密钥

在无需浏览器登录的情况下对 Bob 进行自动化工作流的身份认证。适用于试用版和付费计划用户。可单独管理密钥,也可以由管理员跨实例统一管理。

所有权与管理

API 密钥同时与用户和订阅实例绑定。个人用户可以创建、列出并撤销自己的 API 密钥。订阅实例管理员可以列出并撤销其实例中所有用户的 API 密钥。

API 密钥管理页面

API 密钥类型

你可以创建两种 API 密钥:

类型范围与用途
通用与你的订阅实例绑定,可跨多个服务使用。对于推理请求,还必须包含团队 ID 请求头。
推理与特定订阅实例和团队绑定,仅限于推理请求。无需额外的实例或团队请求头。

何时使用 API 密钥

在以下情况下使用 API 密钥:

  • 在非交互式会话中对 Bob Shell 进行身份认证
  • 在 CI/CD 流水线或定时自动化中运行 Bob
  • 避免在脚本化工作流中使用基于浏览器的登录
  • 使用通用或推理 API 密钥对推理请求进行身份认证

创建 API 密钥

访问 bob.ibm.com 并登录。

打开你的订阅实例,导航至 API 密钥管理部分。

尚无密钥时的 API 密钥管理部分

创建新的 API 密钥,并选择要创建的密钥类型。

创建 API 密钥对话框

复制 API 密钥值并妥善保存。

警告:

创建后将无法再次查看 API 密钥值。

管理你的 API 密钥

你可以在 API 密钥管理部分执行以下操作:

  • 列出你的 API 密钥
  • 搜索和筛选密钥
  • 查看 API 密钥详情
  • 撤销有效密钥
  • 将已撤销密钥与有效和已过期密钥一同显示

管理员功能

订阅实例管理员可以跨实例管理 API 密钥。管理员功能包括:

  • 列出实例中所有用户的 API 密钥
  • 撤销实例中任意用户的 API 密钥
  • 查看有效、已撤销和已过期密钥

在 Bob Shell 中使用 API 密钥

如需在 Bob Shell 中使用 API 密钥,请参阅安装和设置 Bob Shell 以及启动非交互式会话

这个主题怎么样?