Docs 菜单
Docs 主页
/
MongoDB Atlas
/
程序化访问
/
Atlas Administration API
/
开始体验

托管对项目的编程访问

在此页面上

  • 必需的访问权限
  • 查看项目中的 API密钥
  • 更改API密钥在项目中的角色
  • 编辑 API 密钥的访问列表
  • 从项目中删除 API 密钥

使用以下过程管理对项目的编程访问。要了解详情，请参阅授予对项目的编程访问权限。

必需的访问权限

要执行以下任何操作，您必须对该项目拥有 Project Owner访问权限。

查看项目中的 API 密钥

要使用 Atlas CLI 列出项目的所有 API 密钥，请运行以下命令：

atlas projects apiKeys list [options]

要了解有关命令语法和参数的更多信息，请参阅针对 Atlas 项目 apiKeys 列表的 Atlas CLI 文档。

您可以使用 命令查看项目 API 密钥的 APIatlas organizations 访问列表条目。

要使用 Atlas CLI 列出 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists list <apiKeyID> [options]

要了解有关命令语法和参数的更多信息，请参阅 Atlas organizations apiKeys accessLists list 的 Atlas CLI 文档。

要使用 Atlas 用户界面查看项目中API密钥的详细信息，请执行以下操作：

1

在 Atlas 中，转到Project Access Manager 页面。

  1. 如果尚未显示，请从导航栏中的Organizations菜单。

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

  3. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Project Access 。

    • 在Projects菜单旁边，展开Options菜单，单击Project Settings ，然后单击侧边栏中的Access Manager 。

    显示“项目访问管理器”页面。

2

单击API Keys 标签页。

3

查看访问列表。

  1. 单击在API密钥右侧。

  2. 单击 View Details（连接）。

<Public Key> API Key Details模式显示以下信息：

  • 混淆后的 Private Key

  • 上次使用密钥的日期

  • 创建密钥的日期

  • API 密钥可以访问 API 的一个或多个 IP 地址

更改 API 密钥在项目中的角色

1

在 Atlas 中，转到Project Access Manager 页面。

  1. 如果尚未显示，请从导航栏中的Organizations菜单。

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

  3. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Project Access 。

    • 在Projects菜单旁边，展开Options菜单，单击Project Settings ，然后单击侧边栏中的Access Manager 。

    显示“项目访问管理器”页面。

2

单击API Keys 标签页。

3

编辑访问列表。

  1. 单击在API密钥右侧。

  2. 单击 Edit Permissions（连接）。

4

从 菜单中为 API 密钥选择一个 或多个新角色Project Permissions 。

5

单击 以保存。

编辑 API 密钥的访问列表

您可以使用 命令编辑项目 API 密钥的 APIatlas organizations 访问列表条目。

为 API 密钥添加 API 访问列表条目

要使用 Atlas CLI 创建 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists create [options]

要了解有关命令语法和参数的更多信息，请参阅 Atlas CLI 文档中的 atlas organizations apiKeys accessLists create。

删除 API 密钥的 API 访问列表条目

要使用 Atlas CLI 删除 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists delete <entry> [options]

要了解有关命令语法和参数的更多信息，请参阅atlas organizations apiKeys accessLists delete 的 Atlas CLI 文档。

1

在 Atlas 中，转到Project Access Manager 页面。

  1. 如果尚未显示，请从导航栏中的Organizations菜单。

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

  3. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Project Access 。

    • 在Projects菜单旁边，展开Options菜单，单击Project Settings ，然后单击侧边栏中的Access Manager 。

    显示“项目访问管理器”页面。

2

单击API Keys 标签页。

3

编辑访问列表。

  1. 单击在API密钥右侧。

  2. 单击 Edit Permissions（连接）。

注意

选择Edit Permissions ，进入 Atlas 控制台的组织级别。

4

编辑API Access List 。

您无法修改现有的API密钥访问列表条目。您必须删除并重新创建它。

  1. 单击将其删除。

  2. 添加您希望 Atlas 接受对此 API 密钥的 API 请求的新 IP 地址或 CIDR 区块。使用以下两个选项之一：

    • 单击Add access list Entry并输入IP地址，或者

    • Use Current IP Address如果您用于访问 Atlas 的主机也将使用此 API 密钥发出 API 请求，请单击 。

  3. 单击 Save（连接）。

5

单击Done 。

从项目中删除 API 密钥

要使用 Atlas CLI 删除项目的 API 密钥，请运行以下命令：

atlas projects apiKeys delete <ID> [options]

要了解有关命令语法和参数的更多信息，请参阅 Atlas项目 apiKeys delete 的 Atlas CLI 文档。

要使用 Atlas 用户界面从项目中删除API密钥，请执行以下操作：

1

在 Atlas 中，转到Project Access Manager 页面。

  1. 如果尚未显示，请从导航栏中的Organizations菜单。

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

  3. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Project Access 。

    • 在Projects菜单旁边，展开Options菜单，单击Project Settings ，然后单击侧边栏中的Access Manager 。

    显示“项目访问管理器”页面。

2

单击API Keys 标签页。

3

单击 在要删除的 API 密钥右侧。

4

单击Delete 以确认您要删除此 API 密钥，或单击 Cancel以将密钥保留在项目中。

后退

多个组织