API-KEY管理

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

本文主要介绍如何通过向量检索服务控制台创建、查看和删除API-KEY。

前提条件

创建API-KEY

  1. 登录向量检索服务管理控制台

  2. 在左侧导航栏选择API-KEY管理,然后单击创建新的API-KEYimage.png

  3. 在新创建的API-KEY信息弹窗界面,您可以单击复制并在安全的地方保存API-KEY。此次创建的API-KEY可立即用于调用向量检索服务的API。image.png

查看API-KEY

如想再次查看已创建的API_KEY,可在API-KEY管理页面,找到需要查看的API-KEY,单击操作栏的查看按钮,通过验证后即可查看并复制API_KEY信息。

重要

出于安全考虑,关闭弹窗后,您可以在API-KEY管理页面通过账号验证的方式再次查看API-KEY。

  1. 在操作栏单击查看image.png

  2. 进行安全验证image.png1690855125831_560384D0-A566-47ca-A5A4-F80C6977B176.png

  3. 安全验证通过即可查看API-KEY的详细信息。image.png

删除API-KEY

如果已经创建了3个API-KEY,但是还需要新的API-KEY,可在API-KEY管理页面选择想要删除的API-KEY,单击操作栏的删除按钮。在弹窗单击确定删除按钮,然后进行安全验证,通过安全验证后,即完成该条API-KEY的删除。

警告

向量检索服务通过API-KEY进行调用鉴权和计量计费。API-KEY被删除后,采用该API-KEY的后续调用均会被拒绝。请谨慎操作。

image.png

进行安全验证

image.png

1690855125831_560384D0-A566-47ca-A5A4-F80C6977B176.png

保护并正确使用API-KEY

重要

API-KEY是访问向量检索服务的密钥,请务必妥善保存。不要以任何方式公开到外部渠道,避免因未经授权的使用造成安全风险或资金损失。

  • 向量检索服务通过API-KEY进行调用鉴权和计量计费。目前仅支持主账号进行API-KEY的管理,每个主账号最多同时可以拥有3个有效的API-KEY。API-KEY不应被分享给未经授权的开发者。

  • 为了防止API-KEY的创建功能被滥用,每个主账号每天仅可进行10次API-KEY新建操作。

  • 为了保护API-KEY不被泄露,API调用应该仅发起于服务端。任何发起自客户端的API调用,例如浏览器、app、小程序等,均有可能造成API-KEY的泄露。