API 密钥
在用户或应用程序调用 API 或 SDK 访问 Zilliz Cloud 控制面和数据面资源时，需要使用API 密钥进行身份认证。API 密钥是一个由字母和数字组成的字符串。每个密钥有自己的属性，如名称和 ID。
API 密钥概述
为应对不同需求场景，Zilliz Cloud 提供了两种主要的 API 密钥类型：
-
个人 API 密钥：每个用户注册 Zilliz Cloud 账号时会自动生成一个相关联的个人密钥。该密钥继承对应用户在所属组织和项目中的角色权限。如果账号用户离开组织，其关联的个人密钥将被自动删除。作为组织管理员或项目管理员，您可以在 Zilliz Cloud 控制台上看到两种类型的个人 API 密钥：
-
您的个人 API 密钥：专属于您的个人密钥。您可以查看并复制此 API 密钥。
-
组员的个人 API 密钥：组织或项目中其他成员所拥有的个人密钥列表。您只能查看这些密钥的名称和 ID，无法复制或查看密钥本身。
-
-
自定义密钥：由组织管理员和项目管理员手动创建，供应用程序或没有注册 Zilliz Cloud 账号的外部用户使用。自定义密钥适用于需要长期访问 Zilliz Cloud 资源的场景，确保即使 API 密钥的创建人离开组织，应用和外部用户也可以不间断地访问 Zilliz Cloud 资源。
以下图表展示了 API 密钥的角色和资源访问权限。
下表展示了不同角色的用户所具备的 API 密钥权限范围。更多有关角色和权限信息，请参考访问控制。
API 密钥角色 | 权限范围 | |
|---|---|---|
组织管理员 | 具备组织内所有资源（包括组织内所有项目和集群）的管理员权限。 | |
组织账单管理员 | 仅具备组织账单的管理员权限。无权限访问组织内的项目或集群。 | |
组织成员 | 项目管理员 | 默认情况下，具备指定项目和项目下所有集群的管理员权限。 |
项目编辑者（Read-Write） | 默认情况下，具备指定项目和项目下所有集群的读写权限。 | |
项目查看者（Read-Only） | 默认情况下，具备指定项目和项目下所有集群的只读权限。 | |
使用限制
-
每个组织中可创建最多 100 个自定义 API 密钥。
-
API 密钥的管理权限由用户的组织和项目角色决定。具体权限如下：
组织管理员
组织账单管理员
组织成员
项目管理员
项目编辑者（Read-Write）
项目查看者（Read-Only）
您的个人 API 密钥
创建
系统自动创建
系统自动创建
系统自动创建
系统自动创建
系统自动创建
查看并复制
✔️
✔️
✔️
✔️
✔️
编辑
✘
✘
✘
✘
✘
重置
✔️
✔️
✔️
✔️
✔️
删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
组员的个人 API 密钥
创建
系统自动创建
系统自动创建
系统自动创建
系统自动创建
系统自动创建
查看名称和 ID
✔️
✘
✔️
✘
✘
复制
✘
✘
✘
✘
✘
编辑
✘
✘
✘
✘
✘
重置
✘
✘
✘
✘
✘
删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
在用户离开组织时由系统自动删除
自定义 API 密钥
创建
✔️
✘
✔️
✘
✘
查看并复制
✔️
✘
✔️
✘
✘
编辑
✔️
✘
✔️
✘
✘
重置
✔️
✘
✔️
✘
✘
删除
✔️
✘
✔️
✘
✘
创建 API 密钥
在 Zilliz Cloud 中，除了系统为每位组织用户自动生成的个人密钥外，您还可以手动创建自定义密钥。仅组织管理员和项目管理员有权限创建自定义 API 密钥。
-
前往组织 API 密钥页面。点击 + API 密钥。
-
输入 API 密钥名称并设置 API 密钥权限。
-
API 密钥名称： 名称长度不可超过 64 个字符。
-
API 密钥权限：您可以通过指定用户角色或特定项目，来定义自定义 API 密钥的访问范围。为实现更精细化的访问控制，您还可以通过将访问权限限制到指定集群来限制密钥可访问的集群范围。
📘说明项目管理员授予自定义 API 密钥的权限受到其自身权限范围的限制。
-
查看 API 密钥
前往组织 API 密钥页面。根据您的角色，您所看到的页面内容会所有不同。
-
如果您是组织管理员，您可以查看自己的个人 API 密钥、所有组员的个人 API 密钥和所有自定义 API 密钥。
-
如果您是项目管理员，您可以查看自己的个人 API 密钥以及您权限范围内的组员个人密钥和自定义密钥。例如，如果用户1仅是项目A的项目管理员，而密钥1拥有项目A、B和C的管理员权限，那么由于其访问范围超出了用户1的权限，密钥1对用户1不可见。
-
如果您是组织账单管理员、项目编辑者（Read-Write）或项目查看者（Read-Only），您只能查看您自己的个人 API 密钥。
下图展示了组织管理员所能看到的界面内容。
编辑 API 密钥
目前，您只能编辑自定义 API 密钥。个人 API 密钥无法编辑，因为它们与账户用户绑定。如需修改个人密钥的权限，请先调整用户的组织和项目角色。个人 API 密钥的权限将根据用户的新角色自动调整。
以下说明介绍了如何编辑自定义 API 密钥。
-
前往组织 API 密钥页面。点击目标自定义 API 密钥右侧操作栏中的 ...，点击编辑。
-
编辑 API 密钥名称和 API 密钥权限。
-
API 密钥名称： 名称长度不可超过 64 个字符。
-
API 密钥权限：您可以通过指定用户角色或特定项目，来定义自定义 API 密钥的访问范围。为实现更精细化的访问控制，您还可以通过限制集群访问权限来限制密钥可访问的集群范围。
📘说明项目管理员授予自定义 API 密钥的权限受到其自身权限范围的限制。
-
重置 API 密钥
如果您的个人 API 密钥或自定义 API 密钥不慎被泄露，请立即重置密钥。
重置后，当前的 API 密钥将会失效。任何使用当前密钥的应用程序代码将停止运行，请务必及时更新代码中的 API 密钥信息。
根据密钥的类型，操作流程有所不同：
-
重置个人 API 密钥：不论您是什么组织或项目角色，都可以重置您自己的个人 API 密钥。
-
重置自定义 API 密钥：仅组织管理员和项目管理员有权限重置自定义 API 密钥。
删除 API 密钥
我们建议您及时删除不再使用的自定义 API 密钥。仅组织管理员和项目管理员有权限删除自定义 API 密钥。
个人 API 密钥无法手动删除。但是，当 Zilliz Cloud 账号用户离开组织时，其关联的个人 API 密钥将被删除。
下图展示了如何删除自定义 API 密钥。
该操作不可撤销。删除后， 任何使用该 API 密钥的应用将无法再访问 Zilliz Cloud 资源。
