对于 AI 代理：可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单
Docs 主页
/ /
配置访问权限
Docs 主页
/ /
API
/
配置访问权限
Docs 主页
/
管理
/
Ops Manager
/
API
/
配置访问权限

对MongoDB Ops Manager 的编程API访问

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

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

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

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

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

管理对组织的编程访问

注意

所需权限

要执行以下任何操作，您必须具有 Organization Owner 角色。

在组织中创建 API 密钥

1
导航至您组织的Access Manager 页面。

  1. 如果尚未显示，请从导航栏的 Organizations（组织）菜单中选择所需的组织。

  2. 点击侧边栏中的 Access Manager，或点击导航栏中的 Access Manager，然后点击您的组织。

2
单击API Keys 标签页。
3
单击Create API Key 。
4
填写 API Key Information 表单。

在Add API Key页面的API Key Information步骤中：

字段
值

说明

输入新API密钥的描述。

组织权限

为 API 密钥选择一个 或多个新角色 。

5
单击Next 。
6
为此 API 密钥添加访问列表值。

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

对于此API密钥，您可以选择：

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

  • 如果用于访问 Ops Manager 的主机将发出API请求，请单击Use Current IP Address 。

7
单击Save 。

警告

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

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

查看组织中 API 密钥的详细信息

1
导航至您组织的Access Manager 页面。

  1. 如果尚未显示，请从导航栏的 Organizations（组织）菜单中选择所需的组织。

  2. 点击侧边栏中的 Access Manager，或点击导航栏中的 Access Manager，然后点击您的组织。

2
单击API Keys 标签页。
3
导航至 View Details。

  1. 在API密钥旁边，单击。

  2. 单击 View Details（连接）。

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

    • 混淆Private Key 。

    • 上次使用密钥的日期。

    • 密钥的创建日期。

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

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

更改组织中的 API 密钥

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

1
导航至您组织的Access Manager 页面。

  1. 如果尚未显示，请从导航栏的 Organizations（组织）菜单中选择所需的组织。

  2. 点击侧边栏中的 Access Manager，或点击导航栏中的 Access Manager，然后点击您的组织。

2
单击API Keys 标签页。
3
选择要编辑的 API 密钥。

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

  2. 单击 Edit（连接）。

4
填写 API Key Information 表单。

在Add API Key页面的API Key Information步骤中：

字段
值

说明

输入新API密钥的描述。

组织权限

为 API 密钥选择一个 或多个新角色 。

5
单击Next 。
6
为此 API 密钥添加访问列表值。

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

对于此API密钥，您可以选择：

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

  • 如果用于访问 Ops Manager 的主机将发出API请求，请单击Use Current IP Address 。

7
单击Save 。

警告

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

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

从组织中删除 API 密钥

1
导航至您组织的Access Manager 页面。

  1. 如果尚未显示，请从导航栏的 Organizations（组织）菜单中选择所需的组织。

  2. 点击侧边栏中的 Access Manager，或点击导航栏中的 Access Manager，然后点击您的组织。

2
单击API Keys 标签页。
3
删除 API 密钥。

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

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

注意

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

托管对项目的编程访问

注意

所需权限

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

为项目创建 API 密钥

1
Access Manager导航至项目的 页面。

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

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

  3. 点击导航栏中的 Access Manager（存取管理器），然后点击您的项目。

2
单击API Keys 标签页。
3
单击Create API Key 。
4
填写 API Key Information 表单。

在Add API Key页面的API Key Information步骤中：

字段
值

说明

输入新API密钥的描述。

项目权限

为 API 密钥选择一个 或多个新角色 。

5
单击Next 。
6
为此 API 密钥添加访问列表值。

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

对于此API密钥，您可以选择：

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

  • 如果用于访问 Ops Manager 的主机将发出API请求，请单击Use Current IP Address 。

7
单击Save 。

警告

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

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

查看项目中 API 密钥的详细信息

1
Access Manager导航至项目的 页面。

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

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

  3. 点击导航栏中的 Access Manager（存取管理器），然后点击您的项目。

2
单击API Keys 标签页。
3
导航至 View Details。

  1. 在API密钥旁边，单击。

  2. 单击 View Details（连接）。

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

    • 混淆Private Key 。

    • 上次使用密钥的日期。

    • 密钥的创建日期。

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

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

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

1
Access Manager导航至项目的 页面。

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

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

  3. 点击导航栏中的 Access Manager（存取管理器），然后点击您的项目。

2
单击API Keys 标签页。
3
选择要编辑的 API 密钥。

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

  2. 单击 Edit（连接）。

4
填写 API Key Information 表单。

在Add API Key页面的API Key Information步骤中：

字段
值

说明

输入新API密钥的描述。

项目权限

为 API 密钥选择一个 或多个新角色 。

5
单击Next 。
6
为此 API 密钥添加访问列表值。

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

对于此API密钥，您可以选择：

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

  • 如果用于访问 Ops Manager 的主机将发出API请求，请单击Use Current IP Address 。

7
单击Save 。

警告

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

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

从项目中删除 API 密钥

1
Access Manager导航至项目的 页面。

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

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

  3. 点击导航栏中的 Access Manager（存取管理器），然后点击您的项目。

2
单击API Keys 标签页。
3
删除 API 密钥。

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

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

注意

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

后退

配置访问权限

来年

Tutorials

在此页面上