跳转至

Workspace API Key 功能说明

一、功能概述

1. 什么是 API Key

Workspace API Key 是隶属于工作空间(Workspace)的 API 调用鉴权凭证,主要用于通过接口方式调用平台内的模型与算力资源。

该凭证与账号体系无直接从属关系,仅归属于单一 Workspace,创建后天然具备所属 Workspace 内全部模型资源的调用权限,是项目级、业务级调用场景下的核心鉴权方式。

2. 核心作用

  • API 调用鉴权:作为合法身份凭证,调用平台开放的所有模型推理、资源管理类 API 服务。

  • 资源边界隔离:密钥调用权限天然与所属 Workspace 绑定,无法跨工作空间调用资源,从机制上杜绝跨项目资源访问,保障数据与业务安全。

  • 多场景分权分发:单个 Workspace 下支持创建多组 API Key,可分别分配给不同业务系统、开发/测试/生产环境、外部合作方使用;密钥独立管理、互不干扰,可按需单独吊销。

  • 成本精准归集:通过 API Key 产生的所有调用费用,统一归集至所属 Workspace 维度,支持按项目、业务线独立核算账单。

二、创建与管理

1. 新增工作区

a. 登录控制台,进入左侧导航栏【工作区】-【工作区与 API Key】页面。

b. 点击左侧工作区列表上方的「+」按钮,弹出【新增工作区】弹窗。

C. 填写必填项「名称」,可补充「描述」信息。

d. 点击【确定】完成创建,新工作区将出现在左侧列表中。

alt text

2. 为工作区授权账号

a. 在左侧工作区列表选中目标工作区,切换到右侧【成员管理】标签页。

b. 从「未授权账号」列表中勾选需要授权的用户账号,点击中间箭头按钮,将账号移动至「已授权账号」列表。

c. 确认授权账号无误后,点击页面底部【保存】按钮,完成账号授权。

alt text

3. 配置 API Key

MaaS 产品线 API Key 创建

a. 选中目标工作区,切换到右侧【API KEY】标签页,再选择【MaaS】子标签。

b. 点击右上角【新建 API Key】按钮,弹出创建弹窗。

c. 配置参数:

- 业务类型:固定为「MaaS」

- API Key:点击「生成」按钮自动生成密钥

- 白名单:填写 IP 白名单(支持 IP 段,英文逗号分隔,非必填)

- 备注:填写用途说明(非必填)

d. 点击【确定】完成创建,API Key 将显示在列表中。

e. 同一工作区下支持创建多条 API Key 。

alt text

Search 产品线 API Key 创建

单个创建

a. 在【API KEY】标签页选择【Search】子标签,点击【新建 API Key】。

b. 选择「单个创建」模式,配置参数:

- 业务类型:固定为「Search」

- 白名单:填写 IP 白名单(非必填)

- 搜索限速:设置 QPS 上限(默认不限速)

- 名称:自定义 Key 名称(系统会自动生成默认值)

c. 点击【确定】完成创建。

alt text

批量创建

a. 选择「批量创建」模式,配置参数:

- 业务类型:固定为「Search」

- 创建数量:填写需要生成的 Key 数量

- 命名规则:填写前缀或多个名称(逗号分隔,数量需与创建数量一致)

- 白名单:统一设置 IP 白名单(非必填)

- 限速设置:可选择「全部一致」统一限速,或「分别设置」单独配置每个 Key 的 QPS 上限

b. 点击【确定】批量生成 API Key。

alt text

4. API Key 列表操作

创建完成后,API Key 会在列表中展示,支持以下操作:

a. 查看明文:点击列表中密钥旁的「眼睛图标」,可临时显示完整的明文 API Key;再次点击可隐藏密钥。

b. 复制密钥:点击「复制图标」,一键复制完整 API Key,便于直接粘贴使用。

c. 编辑配置:点击「编辑」按钮,可修改该 API Key 的 IP 白名单、备注。

d. 删除密钥:点击「删除」按钮,可删除该 API Key 。

e. 刷新与导出:点击「刷新」按钮可同步最新数据;「动态列」支持自定义列表展示字段。

alt text

5. 子账号配置API Key权限

a. 进入左侧导航栏【权限与日志】-【角色管理】页面,切换到【角色授权】标签页。

b. 在左侧角色列表中选中目标角色,点击右侧「包含用户」下拉框,选择需要配置权限的账号。

c. 在「授权菜单」中找到【API KEY】模块,勾选需要分配的权限项:

- Read:查看 API Key 列表与详情

- Create:新建 API Key

- Update:编辑 API Key

- Delete:删除 API Key

d. 确认权限配置无误后,系统将自动保存,用户权限为所有角色授权菜单的并集。

e. 补充说明:

- 权限控制逻辑:子账号对 API Key 的操作权限,由角色管理中分配的 Read/Create/Update/Delete 权限决定,需同时拥有工作区成员权限 \+ API Key 操作权限,才能正常使用。

alt text

三、子账号密钥AK与API Key

1. 子账号密钥AK

核心定义

子账号AK是账号身份的API调用凭证,从属账号体系,与账号一一绑定,其调用权限范围与所属账号的Workspace授权范围完全同步。

核心规则

a. 归属与数量:1个账号(主账号/子账号)仅可创建1组AK,密钥所有权归属于对应账号。

b. 权限逻辑:AK的权限完全跟随所属账号:账号被授权哪些Workspace,AK即可调用对应Workspace下的全部模型与资源;支持为单个账号授权多个Workspace,实现一组AK调用多个Workspace(工作空间)资源。

c. 权限管理:通过角色管理模块统一调整子账号的Workspace授权,权限变更后AK立即生效,无需更换密钥。

d. 账单归集:通过AK产生的所有资源调用费用,统一计入对应子账号维度,可按子账号拆分核算账单。

适用场景

  • 需跨多个Workspace调用资源,希望通过一组密钥统一管理调用,避免维护多份密钥;

  • 按人员、项目组维度进行成本核算,每个团队/成员对应独立子账号,费用直接归集到对应账号;

  • 由管理员统一管控全平台调用权限,通过子账号权限体系批量调整授权,无需逐个修改密钥。

2. Workspace API Key

核心定义

Workspace API Key是从属Workspace体系的API调用凭证,与账号无直接从属关系,仅归属于单一Workspace,天然具备该Workspace内全部资源的调用权限。

核心规则

a. 归属与数量:1个API Key仅归属于1个Workspace;单个Workspace下可根据业务需求创建多个API Key。

b. 权限逻辑:密钥天然拥有所属Workspace下全部模型与资源的调用权限,无需额外账号授权;密钥边界与Workspace边界完全一致,天然无法跨Workspace调用资源。

c. 权限管理:拥有对应Workspace管理权限的子账号,均可在Workspace内自主创建、编辑、删除API Key;有该Workspace权限的其他子账号同样可管理这些API Key

d. 账单归集:通过API Key产生的所有资源调用费用,统一计入所属Workspace维度,可按Workspace拆分核算账单。

适用场景

  • 单项目独立部署,需要为不同业务系统、不同环境(测试/预发/生产)分配独立调用密钥,互不干扰;

  • 对资源隔离与数据安全有高要求,需要严格限定密钥仅能访问指定Workspace内的资源,杜绝跨项目调用;

  • 按业务线、项目维度独立核算成本,费用直接归属对应Workspace,适配集团化、多业务线独立核算的管理模式;

  • 需要向第三方合作方、外部系统分发调用密钥,可单独创建并随时吊销,不影响Workspace内其他业务与账号权限。

3. 核心差异对比

对比维度 子账号访问密钥(AK) Workspace API Key
归属主体 归属账号,与账号一一绑定 归属Workspace,与账号无直接从属关系
数量限制 1个账号仅能创建1组AK 1个Workspace可创建多个;单密钥仅属于1个Workspace
权限范围 与账号授权的Workspace范围一致,支持跨多个Workspace调用 仅拥有所属Workspace的资源权限,天然不可跨Workspace调用
资源隔离性 无天然隔离边界,权限由账号授权灵活调整 天然Workspace级强隔离,密钥边界与资源边界完全一致
账单归集维度 子账号维度 Workspace维度
管理主体 主账号通过用户管理模块统一管控 拥有Workspace权限的账号均可自主管理
权限调整方式 调整账号的Workspace授权,密钥无需更换 无法单独调整单密钥权限,需吊销重建或调整Workspace资源范围

4. 选型指引

  • 若核心诉求为灵活跨Workspace调用、按人员/团队维度管控权限与核算成本,推荐使用子账号AK

  • 若核心诉求为强资源隔离、单项目多密钥分发、按Workspace维度独立核算、满足合规要求,推荐使用Workspace API Key