Skip to content

API Key

签发、授权、轮换和吊销你的代码用来认证的 Workspace API Key。

Updated View as Markdown
For humans

Workspace API Key 是你的代码发给 Gateway 的唯一凭据。它认证的是一个 Workspace 和一个调用方, 从不携带 provider 凭据。

一个 Key 是什么

  • 一个 Workspace。 Key 只能到达签发它的 Workspace 里的 Pool。
  • 一个 Environment。 production 或 development。开发用的 Key 不会被生产流量接受。
  • runtime 作用域。 它只用来调模型接口,别的都做不了。
  • Pool 授权。 只能调用你明确授权给它的 Pool。
  • 可选的按 Key 速率上限,用于把某个调用方压得比 Pool 上限更低。

密钥只在签发时显示一次,以 rk_ 开头。请存进密钥管理服务;控制台、CLI 和 API 都不会再显示它。

签发

打开 API keys,选好 Environment,勾选要授权的 Pool,然后复制一次密钥。用 CLI 的话:

airuntime api-keys issue --workspace ws_1 --label checkout --pool pool_1

轮换

轮换会换掉密钥本身,保留这个 Key 的 Environment、作用域、Pool 授权与速率上限。所以凭据泄漏时可以 直接滚一次,而不用重新规划权限:

airuntime api-keys rotate --workspace ws_1 --key key_1

吊销

吊销立即生效,没有宽限期,已经发出的请求也不会退费:

airuntime api-keys revoke --workspace ws_1 --key key_1

盯住用量

每个 Key 都会记录最后使用时间,它发起的每次请求都会带着这个 Key 出现在 Requests 里。这是找出 异常花费或失败 Pool 背后调用方最快的方式。

Type to search…

↑↓ navigate↵ selectEsc close