开始使用 Atlas Administration API

授予 Atlas 的编程访问权限

若要仅使用 API 向组织或项目授予程序访问权限，请创建一个 API 密钥。

• API 密钥分为两部分：公钥和私钥。当您向 Atlas 请求 API 时，这两个部分与用户名和个人 API 密钥的功能相同。

• 您无法使用 API 密钥通过用户界面登录 Atlas。

• 你必须向 API 密钥授予角色，就像为用户授予角色一样，以确保 API 密钥可以毫无错误地调用 API 端点。

• 所有API密钥都属于组织。您可以授予对项目的API密钥访问权限。要将新的API密钥添加到项目，请 Invite an Organization API Key to a Project（邀请组织 API 密钥加入项目）。

• 每个 API 密钥仅属于一个组织，但您可以授予 API 密钥访问权限，以访问该组织中任意数量的项目。

可选：需要针对 Atlas Administration API 的 IP 访问列表

Atlas 允许 Atlas Administration API 密钥从互联网上的任意地址发送请求，除非需要针对 Atlas Administration API 的 IP 访问列表。如果需要 IP 访问列表，API 密钥则只能从您在 IP 访问列表中指定的基于位置的 IP 或 CIDR 地址发送 API 请求。

每个 API 密钥都有自己的 IP 访问列表。如果需要为所有 Atlas 管理 API 请求设置 IP 访问列表，则必须为 API 密钥定义至少一个 IP 访问列表条目，然后才能使用 API 密钥。

使用 Atlas 用户界面创建新组织时，Atlas 默认启用 API 访问列表要求。要在创建组织时禁用 IP 访问列表要求，请将 Require IP Access List for the Atlas Administration API 切换为 OFF。

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

为组织授予编程访问权限

使用以下过程向组织授予编程访问权限。要了解详情，请参阅管理对组织的编程访问。

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

使用以下过程授予对项目的编程访问权限。如要了解更多信息，请参阅管理项目的编程访问权限。

提出 API 请求

Atlas Administration API 使用HTTP 摘要式身份验证来对请求进行身份验证。在构建HTTP请求时，您必须提供编程API公钥和相应的私钥作为用户名和密码。要了解如何为 Atlas 项目配置API访问权限，请参阅授予对 Atlas 的编程访问权限。

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

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

API请求示例

您的请求应类似于以下示例，其中，{PUBLIC-KEY} 是您的 API 公钥，{PRIVATE-KEY} 是相应的私钥。

以下示例GET请求将返回组织中的所有项目：

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Content-Type: application/json" \
      --header "Accept: application/vnd.atlas.2023-02-01+json" \
      --include \
      --request GET "https://cloud.mongodb.com/api/atlas/v2/groups"

以下示例POST请求采用请求正文并在组织中创建名为MyProject的项目：

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Content-Type: application/json" \
      --header "Accept: application/vnd.atlas.2023-02-01+json" \
      --include \
      --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
      --data '
         {
            "name": "MyProject",
            "orgId": "5a0a1e7e0f2912c554080adc"
         }'

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

后续步骤

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

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

• 管理对组织的编程访问。

• 管理对多个组织的编程访问。

• 管理对项目的编程访问。