Docs 菜单
Docs 主页
/
MongoDB Atlas
/
程序化访问
/
Atlas Administration 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

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

查看访问列表。

  1. 单击在API密钥右侧。

  2. 单击 View Details（连接）。

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

  • 混淆后的 Private Key

  • 上次使用密钥的日期

  • 创建密钥的日期

  • API 密钥可以访问权限 API 的一个或多个 IP 解决

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

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

列出有权访问权限您的项目的所有服务帐户。

单击服务帐户名称可查看其详细信息，包括：

  • 服务帐户的混淆客户端密钥

  • 上次使用客户端密钥的日期

  • 创建客户端密钥的日期

  • 服务帐户可以访问权限API的IP地址

  • 已为服务帐户分配的角色

您可以使用Atlas Administration API列出有权访问权限您的项目的服务帐户的名称和详细信息。

更改项目的编程访问角色

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

编辑访问列表。

  1. 单击在API密钥右侧。

  2. 单击 Edit Permissions（连接）。

5

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

6

单击 进行保存。

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

4

单击服务帐户的名称。

5

编辑Project Permissions 。

  1. 单击 Edit Permissions（连接）。

  2. 从Project Permissions 菜单中，为服务帐户选择一个或多个新角色。

  3. 单击 Save and next（连接）。

重要

服务帐户凭证将保持活动状态，直到过期或被撤销。

您可以使用Atlas Administration 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组织 apiKeys accessLists 删除的Atlas CLI文档。

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

编辑访问列表。

  1. 单击在API密钥右侧。

  2. 单击 Edit Permissions（连接）。

注意

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

5

编辑API Access List 。

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

  1. 单击删除解决IP。

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

    • 单击Add access list Entry并键入IP解决，或

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

  3. 单击 Save（连接）。

6

单击 Done（保存并关闭）。

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

4

单击服务帐户的名称。

5

编辑API Access List 。

  1. 要添加您希望Atlas接受针对此服务帐户的API请求的IP解决或 CIDR区块，请单击Add Access List Entry 并键入IP解决。

    Use Current IP Address如果您用于访问权限Atlas的托管也将使用此服务帐号发出API请求，您也可以单击 。

  2. 要从访问权限列表中删除IP解决，请单击在IP解决右侧。

  3. 单击 Save（连接）。

您可以使用Atlas Administration API更新项目的服务帐户详细信息。

撤销对项目的编程访问权限

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

atlas projects apiKeys delete <ID> [options]

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

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

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

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

5

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

1

在 Atlas 中，转到 Project Access Manager（项目设置）页面。

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

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

  3. 执行以下步骤之一：

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

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

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

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

4

删除服务帐户。

  1. Actions单击要从项目中删除的服务帐户右侧 下的 图标。

  2. 单击 Remove from this project（连接）。

重要

服务帐户仍然存在于组织中，任何现有凭证都保持活动状态，直到过期或手动撤销。

您可以使用Atlas Administration API从项目中删除服务帐户。

后退

多个组织

来年

Admin API Overview