重要
每个 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.)20
API密钥（HTTP摘要式身份验证）
要学习、了解这些方法，请参阅 Atlas 管理 API 身份验证方法。
以下部分介绍如何使用服务帐户和API密钥来配置对Atlas组织和项目的编程访问权限。
注意
开始之前
在配置程序访问之前，请确认以下内容：
您已有 Atlas 账户。要创建一个，请参阅创建 Atlas 账户。
存在 Atlas 组织。要创建一个，请参阅 创建组织。
必需的访问权限
要为组织创建服务帐户或API密钥，您必须拥有该组织的Organization Owner访问权限。
要授予服务帐户对项目的访问权限，您必须对拥有该项目的组织具有Organization Owner访问权限。
要授予对项目的API密钥访问权限，您必须拥有该项目的 Project Owner访问权限。
可选：需要IP访问列表
使用Atlas用户界面创建组织时， Atlas需要Atlas Administration API的IP访问列表。这会将API请求限制为仅来自您在IP访问列表中指定的基于位置的IP或 CIDR 地址的请求。如果您在没有IP访问列表条目的情况下向Atlas Administration API发出请求，服务器将使用 403 状态代码进行响应。
如果禁用此功能，只要IP访问列表为空，您就可以从互联网上的任何解决发出API请求。添加IP访问列表条目后，只有源自该IP解决的请求才能发出请求。
注意
IP访问权限列表仅应用于编程API密钥和服务帐户。它们不适应用对Atlas Administration API 的其他类型的访问权限，例如Atlas CLI或通过Atlas App Connections 授予的委派访问权限。委托访问权限包括第三方合作应用程序、 MongoDB应用程序（例如MongoDB Compass）和模型上下文协议 (MCP) 客户端。如果您的组织要求所有Atlas Administration API流量都源自特定地址，请勿为该组织启用委派应用访问权限启用。在现有组织中，合作应用程序和 MCP 客户端的委派访问权限设置默认处于关闭默认。
要将您的组织设置为在创建组织后要求为每个 Atlas Administration API 请求提供 IP 访问列表，请执行以下步骤：
在 Atlas 中，转到 Organization Settings（项目设置）页面。
如果尚未显示，组织从导航栏中的Organizations菜单。
在侧边栏中，单击 Organization Settings。
显示“组织设置”页面。
为组织授予编程访问权限
授予对项目的编程访问权限
要学习了解有关这两种身份验证方法的更多信息，请参阅Atlas 管理 API身份验证方法。
要授予对项目的API密钥访问权限，您必须拥有该项目的 Project Access Manager 或 Project Owner访问权限。
从项目添加项目访问权限
如果您尚未为组织创建服务帐户或API密钥，则可以为项目创建服务帐户或 API 密钥，以授予该项目对Atlas Administration 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 命令：
后续步骤
要了解有关 Atlas Administration API 的更多信息，请参阅 Atlas Administration API 参考资料。
要管理对 Atlas Administration API 的编程访问，请参阅以下任一过程：