管理 API Key

更新时间:
复制为 MD 格式

访问函数计算云沙箱数据面接口(如创建沙箱实例、管理沙箱运行时)时,需要通过 X-API-KEY 请求头传递 API Key 完成身份认证。通过函数计算控制台,可以创建、查看、编辑、重置和删除 API Key。

前提条件

  • 已开通函数计算服务。

  • 已开通云沙箱功能。

创建 API Key

  1. 进入云沙箱API Keys管理页面

  2. 在 API Key 管理页面,单击创建 API Key

  3. 创建 API Key面板打开后,配置以下参数。

    参数

    类型

    必填

    默认值

    说明

    描述

    文本输入

    为 API Key 添加描述信息以标识用途。最多 128 个字符,支持字母、数字、中文字符、连字符(-)、下划线(_)、点(.)和空格。

    过期时间

    单选

    永不过期

    设置 API Key 的有效期。可选:永不过期自定义过期时间。选择自定义过期时间时,需要选择一个晚于当前时间的日期。

  4. 单击确定

  5. 创建成功后,页面弹窗展示完整的 API Key 值,请复制并妥善保管。也可随时在 API Key 列表页通过复制按钮获取。

    重要

    请妥善保管 API Key,不要将其硬编码或分享给他人。建议定期重置密钥以确保安全。

查看 API Key 列表

  1. 进入函数计算控制台

  2. 在左侧导航栏,单击云沙箱 > API Keys

API Key 列表展示以下信息:

列名

说明

Access Key

API Key 的脱敏展示值(如 e2b_a1b2****ef01)。单击右侧的复制按钮可获取完整的 API Key 值。

描述

API Key 的描述信息。

账号 ID

创建该 API Key 的账号 ID。此列仅在使用主账号登录时可见。

状态

API Key 的当前状态:已启用表示可正常使用,已禁用表示已停用。

创建时间

API Key 的创建时间。

过期时间

API Key 的过期时间。未设置过期时间时显示永不过期

操作

支持对 API Key 进行编辑删除重置操作。

支持以下方式筛选 API Key:

  • 状态筛选:全部已启用已禁用

  • 描述关键词搜索。

编辑 API Key

支持修改 API Key 的描述、过期时间,以及启用或禁用 API Key。

  1. 进入函数计算控制台。。

  2. 在左侧导航栏,单击云沙箱 > API Keys

  3. 找到目标 API Key,在操作列单击编辑

  4. 编辑 API Key面板打开后,修改以下参数。

    参数

    说明

    描述

    修改 API Key 的描述信息。校验规则与创建时一致。

    过期时间

    修改 API Key 的过期策略:永不过期自定义过期时间

    启用 API Key

    勾选表示启用(已启用),取消勾选表示禁用(已禁用)。禁用后该 API Key 将无法用于数据面认证。

  5. 单击确定。修改成功后,API Key 列表对应记录的描述、过期时间或状态已更新。

重置 API Key

重置 API Key 将生成新的密钥值,并使旧密钥立即永久失效。此操作不可撤销,且会导致正在使用旧密钥的应用瞬间失去访问权限。因此,生产环境严禁直接使用此功能进行常规密钥轮换。建议优先采用“创建 API Key → 应用切换 → 禁用/启用 API Key”的平滑轮转方案,以确保业务连续性。仅在密钥泄露或紧急废止场景下使用本功能。

  1. 进入函数计算控制台。。

  2. 在左侧导航栏,单击云沙箱 > API Keys

  3. 找到目标 API Key,在操作列单击重置

  4. 确认对话框弹出后,确认重置操作。

    警告

    重置后旧密钥立即失效且无法撤销。使用旧密钥的应用将无法访问沙箱数据面接口,请确保及时更新应用中的 API Key。

  5. 重置成功后,页面弹窗展示新的 API Key 值,请复制并妥善保管。也可随时在列表页通过复制按钮重新获取。

禁用/启用 API Key

  1. 进入函数计算控制台。。

  2. 在左侧导航栏,单击云沙箱 > API Keys

  3. 找到目标 API Key,单击编辑进入编辑 API Key页面。

  4. 找到 启用 API Key选项:

    若要禁用密钥:取消勾选 启用 API Key

    若要启用密钥:勾选 启用 API Key

  5. 单击页面底部确定按钮即可生效。

删除 API Key

删除 API Key 前需要先将其禁用。已删除的 API Key 无法恢复。

  1. 进入函数计算控制台。。

  2. 在左侧导航栏,单击云沙箱 > API Keys

  3. 如果目标 API Key 的状态为已启用,先在操作列单击编辑,取消勾选启用 API Key并保存,将状态变更为已禁用

    说明

    已启用状态的 API Key 无法直接删除,删除按钮不可用,提示"请先禁用该 API Key 后再删除"。

  4. 确认 API Key 状态为已禁用后,观察一段时间(建议24H),确认没有问题后,在操作列单击删除,删除后数据不可恢复。

  5. 确认对话框弹出后,确认删除。删除成功后,该 API Key 从列表移除。

使用 API Key

获取 API Key 后,可通过以下方式随请求传递 API Key,访问沙箱数据面接口:

  • HTTP 请求:向请求头添加 X-API-KEY 字段,值为完整的 API Key。

  • E2B SDK:云沙箱兼容 E2B 开源协议,可将阿里云 API Key 设置为 E2B SDK 的 api_key 参数或 E2B_API_KEY 环境变量来使用。

说明

已禁用或已过期的 API Key 无法通过数据面认证,请确保使用的 API Key 处于已启用状态且未过期。

第一次创建API Key,可参考通过 SDK 创建第一个云沙箱来使用。