Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/ /

以编程方式访问 Cloud Manager

在此页面上

  • 管理对组织的编程访问
  • 托管对项目的编程访问

要仅使用 API向组织或项目授予编程访问权限,您可以创建 API密钥。 API密钥:

  • 有两部分:公钥和私钥。

  • 不能用于通过用户界面登录 Cloud Manager。

  • 必须像授予用户一样被授予角色,以确保API密钥可以调用API端点而不会出现错误。

  • 可以属于一个组织,但可以被授予对该组织中任意数量的项目的访问权限。

注意

所需权限

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

  2. 单击 Organizations 菜单旁边的 Organization Settings 图标。

    显示 “组织设置”页面。

2

单击侧边栏中的 Access Manager(支持)。

显示“组织访问经理”页面。

3
4
5

Add API Key页面的API Key Information步骤中:

字段
说明
输入新API密钥的描述。
组织权限
API 密钥选择一个 或多个新角色 。
6
7

Add API Key页面的Private Key & Access List步骤中,单击Add Access List Entry

对于此API密钥,您可以选择:

  • 输入 Cloud Manager 应接受 API 请求的 IPv4 地址,或者

  • 如果您用于访问 Cloud Manager 的主机将发出API请求,请单击Use Current IP Address

8

警告

在离开此页面之前复制私钥

Cloud Manager 会显示Private Key一次:在此页面上。 单击Copy将私钥添加到剪贴板。 像保护任何其他密码一样保存和保护此私钥。

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

  2. 单击 Organizations 菜单旁边的 Organization Settings 图标。

    显示“组织设置”页面。

2

单击侧边栏中的 Access Manager(支持)。

显示“组织访问经理”页面。

3
4
  1. API密钥旁边,单击

  2. 单击 View Details(连接)。

    <Public Key> API Key Details模式显示:

    • 混淆Private Key

    • 上次使用密钥的日期。

    • 密钥的创建日期。

    • 密钥位于访问列表中的IPv4地址。

    • 已授予密钥访问权限的项目。

您可以更改组织中API密钥的角色、描述或访问列表。

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

  2. 单击 Organizations 菜单旁边的 Organization Settings 图标。

    显示“组织设置”页面。

2

单击侧边栏中的 Access Manager(支持)。

显示“组织访问经理”页面。

3
4
  1. 单击在要更改的API密钥旁边。

  2. 单击 Edit(连接)。

5

Add API Key页面的API Key Information步骤中:

字段
说明
输入新API密钥的描述。
组织权限
API 密钥选择一个 或多个新角色 。
6
7

Add API Key页面的Private Key & Access List步骤中,单击Add Access List Entry

对于此API密钥,您可以选择:

  • 输入 Cloud Manager 应接受 API 请求的 IPv4 地址,或者

  • 如果您用于访问 Cloud Manager 的主机将发出API请求,请单击Use Current IP Address

8

警告

在离开此页面之前复制私钥

Cloud Manager 会显示Private Key一次:在此页面上。 单击Copy将私钥添加到剪贴板。 像保护任何其他密码一样保存和保护此私钥。

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

  2. 单击 Organizations 菜单旁边的 Organization Settings 图标。

    显示“组织设置”页面。

2

单击侧边栏中的 Access Manager(支持)。

显示“组织访问经理”页面。

3
4
  1. 单击在要删除的API密钥旁边。

  2. 单击Delete 以确认您要删除此 API 密钥,或单击 Cancel以将密钥保留在组织中。

注意

从组织中删除API密钥也会从该密钥被授予访问权限的任何项目中删除该密钥。

注意

所需权限

要执行以下任何操作,您必须具有 Project User Admin 角色。

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

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

  3. 执行以下步骤之一:

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

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

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

2
3
4

Add API Key页面的API Key Information步骤中:

字段
说明
输入新API密钥的描述。
项目权限
API 密钥选择一个 或多个新角色 。
5
6

Add API Key页面的Private Key & Access List步骤中,单击Add Access List Entry

对于此API密钥,您可以选择:

  • 输入 Cloud Manager 应接受 API 请求的 IPv4 地址,或者

  • 如果您用于访问 Cloud Manager 的主机将发出API请求,请单击Use Current IP Address

7

警告

在离开此页面之前复制私钥

Cloud Manager 会显示Private Key一次:在此页面上。 单击Copy将私钥添加到剪贴板。 像保护任何其他密码一样保存和保护此私钥。

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

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

  3. 执行以下步骤之一:

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

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

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

2
3
  1. API密钥旁边,单击

  2. 单击 View Details(连接)。

    <Public Key> API Key Details模式显示:

    • 混淆Private Key

    • 上次使用密钥的日期。

    • 密钥的创建日期。

    • 密钥位于访问列表中的IPv4地址。

    • 已授予密钥访问权限的项目。

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

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

  3. 执行以下步骤之一:

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

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

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

2
3
  1. 单击在要更改的API密钥旁边。

  2. 单击 Edit(连接)。

4

Add API Key页面的API Key Information步骤中:

字段
说明
输入新API密钥的描述。
项目权限
API 密钥选择一个 或多个新角色 。
5
6

Add API Key页面的Private Key & Access List步骤中,单击Add Access List Entry

对于此API密钥,您可以选择:

  • 输入 Cloud Manager 应接受 API 请求的 IPv4 地址,或者

  • 如果您用于访问 Cloud Manager 的主机将发出API请求,请单击Use Current IP Address

7

警告

在离开此页面之前复制私钥

Cloud Manager 会显示Private Key一次:在此页面上。 单击Copy将私钥添加到剪贴板。 像保护任何其他密码一样保存和保护此私钥。

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

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

  3. 执行以下步骤之一:

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

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

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

2
3
  1. 单击在要删除的API密钥旁边。

  2. 单击Delete 以确认您要删除此 API 密钥,或单击 Cancel以将密钥保留在组织中。

注意

从组织中删除API密钥也会从该密钥被授予访问权限的任何项目中删除该密钥。

后退

配置 API 访问