Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs 菜单
Docs 主页
/ /
管理API
Docs 主页
/
管理
/
API
/
管理API
Docs 主页
/
管理
/
API
/
管理API

开始使用 Atlas Administration API

重要

每个 Atlas Administration API 都有自己的资源，需要进行初始设置。

您只能通过公共互联网访问 Atlas Administration API 服务器。Atlas Administration API 不适用于使用 网络对等互连或私有端点的连接。

要了解更多信息，请参阅 Atlas 编程访问权限。

Atlas 管理 API遵循 REST 架构风格的原则来公开大量内部资源，从而能够以编程方式访问 Atlas 中的管理功能。要学习；了解有关Atlas Administration API 的更多信息，请参阅Atlas Administration API参考。

Atlas 管理 API不提供对集群中存储的数据的访问权限。要在数据库中读取或写入数据，您必须使用具有相应读取或写入 角色 的 数据库用户 的凭证，对集群进行身份验证。您可以使用Atlas Administration API创建和管理数据库用户。

要使用Atlas 管理 API管理Atlas集群，您必须使用以下身份验证方法之一对API请求进行身份验证：

  • 服务帐户访问权限令牌 (OAuth 2.0)

  • API密钥（HTTP摘要式身份验证）

要学习、了解这些方法，请参阅 Atlas 管理 API 身份验证方法。

以下部分介绍如何使用服务帐户和API密钥来配置对Atlas组织和项目的编程访问权限。

注意

MongoDB Atlas责任共担模型定义了MongoDB及其客户在维护安全和弹性数据环境方面的互补职责。在此框架下， MongoDB管理根本的平台的安全性和操作完整性，而客户则负责其特定部署的配置、管理和数据策略。有关安全性和卓越运营之间所有权的详细划分，请参阅责任共担模型。

必需的访问权限

要为组织创建服务帐户或API密钥，您必须拥有该组织的Organization Owner访问权限。

要授予服务帐户对项目的访问权限，您必须对拥有该项目的组织具有Organization Owner访问权限。

要授予API密钥对项目的访问权限，您必须拥有该项目的Project Owner访问权限。

可选：需要IP访问列表

当您使用Atlas用户界面创建组织时， Atlas会自动要求为Atlas Administration API启用IP访问列表。这会将API请求限制为仅来自您在IP访问列表中指定的基于位置的IP或CIDR地址的请求。如果您在没有IP访问列表条目的情况下向Atlas 管理 API发出请求，服务器将使用 403 状态代码进行响应。

如果禁用此功能，只要IP访问列表为空，您就可以从互联网上的任何地址发出API请求。添加IP访问列表条目后，只有源自该IP解决的请求才能发出请求。

注意

IP访问列表应用于使用服务帐户访问令牌，而不是创建或撤销它们。您可以从任何IP生成令牌，但只有当您的IP位于访问权限列表上时，才能使用它来调用API。

要将您的组织设置为在创建组织后要求为每个 Atlas Administration API 请求提供 IP 访问列表，请执行以下步骤：

1

在Atlas中，转到 Organization Settings 页面。

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

  2. 在侧边栏中，单击 Organization Settings。

显示“组织设置”页面。

2

将 Require IP Access List for the Atlas Administration API 设置切换为 On。

为组织授予编程访问权限

授予对项目的编程访问权限

要学习了解有关这两种身份验证方法的更多信息，请参阅Atlas 管理 API身份验证方法。

要授予对项目的API密钥访问权限，您必须拥有该项目的Project Access Manager或Project Owner访问权限。

从项目添加项目访问权限

如果您尚未为组织创建服务帐户或 API 密钥，则可以为项目创建它们，以授予该项目访问 Atlas 管理 API 的权限。为项目创建的服务帐号或 API 密钥会自动添加到父组织中，并获得 Organization Member 权限。

发出API请求

Atlas 管理 API 使用以下两种身份验证方法之一来验证请求：服务帐户或 API 密钥。您需要在配置首选身份验证方法时保存的密钥或机密才能完成以下过程。

所有 Atlas Administration API 端点均有以下基本 URL：

https://cloud.mongodb.com/api/atlas/<version>

重要

MongoDB 使用 HTTPS URL 来提高安全性。使用 HTTP URL 将返回 301 状态码。

提示

或者，您可以使用任何支持 OpenAPI v3 规范 的工具来生成代码示例或模拟服务器。例如，可以将 Atlas Admin API 规范导入 Postman，生成 curl 命令。

警告

在 Postman 中使用 HTTP URL 将按预期返回 301 状态码。然而，在这种情况下，Postman 可能会自动使用 HTTPS 重试请求，但同时会从重试请求中删除标头和正文。这将返回 401 状态码而不是 301，这使得很难确定请求失败的原因。

要使用 Postman 生成 curl 命令：

1

在 MongoDB Atlas 管理 API 文档中，单击导航栏中的 Download source。

2

右键单击要下载的OpenAPI 规范格式，然后复制链接。

3

打开 Postman 并单击 File，然后单击 Import。

显示 Import窗口。

4

在 Import 窗口中，单击 Link 并粘贴您在步骤 2 中复制的下载链接。

5

单击 Continue，然后单击 Import。

6

对于要为其生成 curl 命令的请求，请单击右侧的 </> 并从 Code snippet 下拉列表中选择 cURL。

后续步骤

要了解有关 Atlas Administration API 的更多信息，请参阅 Atlas Administration API 参考资料。

要管理对 Atlas Administration API 的编程访问，请参阅以下任一过程：

后退

管理API

来年

组织访问

在此页面上