Docs 菜单
Docs 主页
/
MongoDB Atlas
/ / /

定义和管理密钥

在此页面上

  • 定义密钥
  • 查看密钥
  • 更新密钥
  • 使用密钥
  • 删除密钥

密钥是存储在Atlas后端并对用户隐藏的私有值。 密钥可用于存储敏感信息,例如API密钥或内部标识符。

定义密钥后,您无法直接读取密钥的值。 相反,您可以将密钥链接到另一个 ,然后从trigger函数访问权限该值。

您可以从用户界面或使用App Services CLI定义新密钥。

1
  1. 导航至Triggers页面:

    1. 如果尚未显示,请从导航栏上的 Organizations 菜单中选择包含项目的组织。

    2. 如果尚未显示,请从导航栏的 Projects 菜单中选择您的项目。

    3. 在侧边栏中,单击 Services 标题下的 Triggers

      显示触发器页面。

  2. 单击 Linked App Service: Triggers(管理员)链接。

  3. 在侧边栏中,单击 Build 标题下的 Values

  4. 单击 Create a Value(连接)。

2

输入密钥的名称。 此名称是在函数中引用密钥的名称,并且在项目中必须是唯一的。

注意

密钥名称限制

值名称不能超过64个字符,并且只能包含 ASCII 字母、数字、下划线和连字符。 第一个字符必须是字母或数字。

3
  1. 选择Secret类型。

  2. Add Content输入框中输入新密钥的值。

    密钥值不得超过 500 个字符。

警告

保存密钥后,您无法直接读取密钥的值。

4

定义密钥后,单击Save 。 如果您的应用程序部署草稿已启用,请单击Review & Deploy以部署更改。

1

使用MongoDB Atlas Administration API密钥登录App Services CLI:

appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"
2

运行以下命令以获取配置文件的本地副本:

appservices pull --remote=<App ID>

默认,该命令会将文件提取到当前工作目录中。 您可以使用可选的 --local标志指定目录路径。

3

运行以下命令以定义新的密钥:

appservices secrets create --app=<Your App ID> \
--name="<Secret Name>" \
--value="<Secret Value>"
4

运行以下命令以部署更改:

appservices push

您可以从用户界面或使用App Services CLI查看应用中所有密钥的列表。

  1. Triggers页面中,单击Linked App Service: Triggers链接。

  2. 在侧边栏中,单击 Build 标题下的 Values

该表列出了所有值,包括密钥,并在其行中指示了每个值的类型。

要列出所有密钥的名称和 ID,请运行以下命令:

appservices secrets list --app=<Your App ID>

您可以从用户界面或使用App Services CLI更新密钥。

要从Atlas用户界面更新密钥,请执行以下操作:

  1. Triggers页面中,单击Linked App Service: Triggers链接。

  2. 在侧边栏中,单击 Build 标题下的 Values

  3. 在表格中找到要更新的值,打开 Actions 菜单,然后选择 Edit Secret

  4. 您可以更改密钥的名称和值。

  5. 单击Save ,然后根据需要部署更改。

要使用App Services CLI更新密钥的值,请运行以下命令:

appservices secrets update --app=<Your App ID> \
--secret="<Secret ID or Name>" \
--name="<Updated Secret Name>" \
--value="<Updated Value>"

定义密钥后,您无法直接读取密钥的值。

要在触发器函数中使用密钥,请执行以下操作:

  1. 创建链接到密钥的新值

  2. 使用context.values模块访问权限函数中密钥的值。

您可以从用户界面或使用App Services CLI删除密钥。

要从Atlas 用户界面中删除密钥,请执行以下操作:

  1. Triggers页面中,单击Linked App Service: Triggers链接。

  2. 在侧边栏中,单击 Build 标题下的 Values

  3. 在表格中找到要删除的值,打开其 Actions 菜单,然后选择 Delete Secret

  4. 确认要删除密钥。

要使用App Services CLI删除密钥,请运行以下命令:

appservices secrets delete --app=<Your App ID> --secret=<Secret ID>

提示

您可以使用单个命令删除多个密钥,方法是将其nameid值指定为逗号分隔的列表。

appservices secrets delete --app=<Your App ID> \
--secret=some-api-key,609af850b78eca4a8db4303f,another-key

后退

聚合