跳转至

API Key管理

API Key 用于通过接口方式安全访问系统能力(如指标查询等)。 本文将为您介绍如何在 Aloudata CAN 中创建 API Key,以及 API key 的使用场景。

一、进入 API Key 管理页面

操作路径:

管理设置 → API Key 管理

在该页面中,你可以完成以下操作:

  • 新建 API Key

  • 查看 API Key 列表

  • 编辑 / 重置 API Key

  • 启用、停用或删除 API Key

二、新建 API Key

2.1 操作步骤

  1. 点击右上角 「+ 新建 API Key」

  1. 填写 API Key 基本信息

  1. 点击 「创建」 完成创建

2.2 字段说明

字段 是否必填 说明
名称 API Key 的名称
映射账号 API Key 绑定的系统账号,接口调用将以该账号权限执行

三、API Key 列表说明

创建完成后,API Key 将展示在列表中。

3.1 列表字段说明

字段 说明
名称 API Key 名称
映射账号 当前绑定的账号
创建时间 API Key 首次创建时间
生成时间 最近一次生成 / 重置 API Key 的时间
创建人 API Key 创建者
启用 是否允许当前 API Key 调用接口
操作 编辑 / 删除

3.2 创建时间 vs 生成时间

  • 创建时间:API Key 首次创建的时间

  • 生成时间:最近一次点击「重新生成 API Key」的时间

该字段可用于判断 Key 是否发生过轮换。

四、编辑 API Key

在 API Key 列表中,点击 「编辑」 可进入编辑页面。

4.1 可编辑内容

字段 是否可编辑 说明
名称 修改 API Key 显示名称
映射账号 重新绑定 API Key 的执行账号
API Key 出于安全原因仅展示脱敏内容

4.2 API Key 安全说明

  • API Key 仅在生成时完整展示

  • 后续仅显示脱敏格式(如 sk-423******

  • 系统不支持再次查看完整 Key

五、重新生成 API Key

在编辑页面中,点击 「重新生成」 可生成新的 API Key。

5.1 重新生成的影响

  • 新 API Key 立即生效

  • 原 API Key 立即失效

  • 所有使用旧 Key 的接口调用将失败

六、启用 / 停用 API Key

API Key 列表中的启用开关用于快速控制 Key 是否可用。

状态 说明
启用 API Key 可正常调用接口
停用 API Key 调用将被拒绝

八、删除 API Key

点击 「删除」 后:

  • API Key 将被永久删除

  • 不可恢复

  • 所有关联调用将立即失效