API Key 与限额
除了两个公开列表,/v1 下的每个调用都要 API Key。key 属于某个项目,写明能用在哪里,还可以有自己的限额。
项目
项目用来给 key 分组,比如每个应用或每个环境一个。模型用量和回执里能看出每个 key 花了多少。
点控制台左栏的「模型 API」,再点「管理 API Key」。在「项目」下填一个名称,点「新建项目」。key 必须属于某个项目,所以先建项目。
创建 key
在「新建 key」下:
| 字段 | 作用 |
|---|---|
| 「项目」 | key 属于哪个项目。 |
| 「备注」 | 方便在列表里认出它。可以不填,最多 80 个字符。 |
| 「用途」 | 「模型 API」「沙盒」「云主机」,可以多选,至少选一个。 |
| 「花费上限(美元,可不填)」 | 这个 key 最多能花多少钱。不填就没有 key 级别的上限。 |
| 「上限周期」 | 「累计」表示整个生命周期,「每月」表示每个 UTC 自然月。 |
| 「每分钟请求数(可不填)」 | 这个 key 每分钟最多发多少个请求。 |
点「创建」。key 只显示这一次,旁边有「复制」按钮,请马上复制。Yi Cloud 只保存它的哈希,之后没法再显示。列表里只显示开头的 pwc_live_…。
用途
| 「用途」 | 能调用的接口 |
|---|---|
| 「模型 API」 | /v1/models、/v1/chat/completions、/v1/responses、/v1/embeddings、/v1/messages |
| 「沙盒」 | /v1/sandboxes 及其下的所有接口 |
| 「云主机」 | /v1/vms 及其下的所有接口 |
GET /v1/catalog 和 GET /v1/compute/classes 不需要 key。
用在用途之外的地方,会得到 403 forbidden,消息是 "This API key may not be used here"。
带「沙盒」或「云主机」用途的 key,能看到并操作你工作区里所有的沙盒或云主机,包括用别的 key 或在控制台创建的。
花费上限
key 的花费上限计入通过它产生的所有费用:
- 它的模型调用。
- 它创建的沙盒。
- 它创建或续费的云主机的租期和续费。
- 它创建的云主机停机后的保留费用。
调用或资源开始之前,Yi Cloud 会检查:这个 key 已经花的、正在预扣的,加上这次的预扣,是否还在上限之内。超出的话返回 402 key_limit_reached。列表里的「已用 / 上限」显示每个 key 本周期的情况。
如果某台停机的云主机,每小时的保留费用已经超出创建它的 key 的上限,这台云主机会被删除。见云主机。
每分钟请求数
这个限制统计 key 发往 /v1 的所有请求,按滑动的 60 秒窗口计算。超出的请求返回 429 rate_limited,Retry-After 响应头里是要等的秒数。
key 之上的限制
每个 key 花的都是工作区的同一份余额,key 的上限设得比余额高并没有用。key 之上没有月度上限。见计费与回执。
吊销 key
点 key 旁边的「吊销」。之后再用它会得到 401 invalid_key,消息是 "This API key was revoked"。它创建的沙盒和云主机会继续运行,直到结束或被你删除。
保管好 key
- 把 key 放在环境变量或密钥管理服务里。不要放进浏览器代码、手机应用或代码仓库。
- 一个应用一个 key,只给它需要的用途。
- 无人值守运行的 key,设一个花费上限。
- 「最后使用」一列显示 key 最近一次使用的时间,精确到分钟。没人用的 key 就吊销掉。
- 怀疑 key 泄露了,就吊销它,再建一个新的。