API Keys 管理¶

观测云支持通过调用 Open API 接口来获取和更新工作空间中的数据。在调用 API 接口之前，您需要先创建一个 API Key 作为身份认证凭证。

API Key 是访问观测云 Open API 的核心凭证，通过请求头中的 DF-API-KEY 字段进行身份验证，并确定请求所属的工作空间。

关于 Open API 的详细接口清单，可参考 Open API。

前置条件¶

您需要拥有观测云工作空间的管理员或 Owner 权限才能创建和管理 API Key；
了解您需要调用的 API 接口所需的权限范围，以便正确配置角色。

创建 API Key¶

操作步骤¶

进入观测云工作空间，点击左侧导航栏 管理 > API Key 管理；
点击右上角新建 Key 按钮；
在弹出的对话框中配置以下信息：
- 名称：为 API Key 设置一个易于识别的名称，最大长度 50 字符；
- 角色：选择该 API Key 关联的角色，决定其权限范围
确定。

角色与权限规则¶

1. Owner 级 API Key 特殊限制

仅 Owner 账号可见，且只能创建 1 条
创建后默认置顶显示在列表首位
对其他角色（包括 Administrator）完全不可见

2. 多角色权限合并

若为一个 API Key 选择了多个角色，最终权限将是所选角色权限的合集（并集）
建议遵循最小权限原则，仅选择必要的角色

获取与使用 API Key¶

创建成功后，在 API Key 列表页，点击进入 API Key 详情，系统展示以下信息：

Key ID：API Key 的唯一标识符
Key（密钥）：用于 API 请求的认证凭证

除此之外，您可按需修改当前 API Key 的名称与角色：

API 认证方式¶

所有 Open API 请求都通过 HTTP Header 进行认证。