Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas CLI

从 Atlas CLI 连接

在此页面上

  • 选择连接方法
  • 使用最少必要设置进行连接
  • 满足先决条件
  • 按照以下步骤操作
  • 采取后续步骤

选择连接方法

当您从 Atlas CLI 连接到现有 Atlas 帐户时，您可以使用以下命令之一进行身份验证：

命令
身份验证方法
用例(Use Case)
atlas auth login
Atlas 登录凭证和身份验证令牌
最适合非编程使用
atlas config init
API 密钥
最适合编程使用

重要

API 密钥以明文形式存储在 Atlas CLI 配置文件中。API 密钥就像密码一样。确保以适当方式保护配置文件。

要创建新的 Atlas 帐户或启用没有任何集群的现有帐户，请参阅开始使用 Atlas。

选择下方的使用案例，以了解有关可用连接选项的更多信息：

使用atlas auth login命令，使用 Atlas 登录档案和一次性身份验证令牌进行身份验证。 atlas auth login需要手动登录并验证身份验证令牌，该令牌的有效期为12小时。使用atlas auth login连接时， API密钥是可选的。

运行 atlas auth login 后，您可以：

  • 按照最低设置要求进行连接，并在每个命令中指定 --projectId 和 --orgId 标志。这是首次登录的最快开始方式。

  • 将连接设置保存在配置文件中。配置文件存储项目 ID、组织 ID 以及可选的API密钥，以便在将来的 Atlas CLI 会话中使用。为了节省时间，您可以指定配置文件，而不是在每个命令中使用--projectId和--orgId标志。

您必须配置 API 密钥才能使用此命令进行身份验证。

当您运行atlas config init命令时，Atlas CLI 会提示您提供API密钥，并自动创建一个存储API密钥的配置文件。 atlas config init最适合以编程方式使用，因为它不需要手动登录或令牌验证。

当您使用带有atlas config init的连接时，您可以：

  • 按照最低设置要求进行连接，并在每个命令中指定 --projectId 和 --orgId 标志。这是首次登录的最快开始方式。

  • 将其他连接设置保存在配置文件中。配置文件存储项目 ID、组织 ID 以及可选的API密钥，以便在将来的 Atlas CLI 会话中使用。为了节省时间，您可以指定配置文件，而不是在每个命令中使用--projectId和--orgId标志。

使用最少必要设置进行连接

选择一个使用案例，按照步骤以所需的最低设置从 Atlas CLI 进行连接。

满足先决条件

按照以下步骤操作

选择一个使用案例并按照步骤从 Atlas CLI 进行快速连接。

1

运行身份验证命令。

在终端中运行 atlas auth login 命令。

atlas auth login

该命令会打开一个浏览器窗口，并返回一个一次性激活码。此激活码会在 10 分钟后过期。

2

登录 Atlas。

如果您尚未登录，请在浏览器中登录您的 Atlas 帐户。

3

输入授权码。

将激活代码粘贴到浏览器中，然后单击 Confirm Authorization 。

4

返回到 Atlas CLI 并接受默认配置文件选项。

返回终端。如果连接成功，您将看到一条消息：

Successfully logged in as {Your Email Address}.

如果显示以下选项，请按 Enter 接受默认配置文件配置：

  • Default Org ID

  • Default Project ID

  • Default Output Format

  • Default MongoDB Shell Path

重要

如果您之前为 MongoCLI 设置了带有API密钥的配置文件，您的配置文件会自动迁移。使用atlas auth login进行身份验证时，某些迁移的配置文件可能会导致 Atlas CLI 命令失败。如果存在冲突，当您运行atlas auth login时，会显示以下消息：

There was an error fetching your organizations: Global user is
from outside whitelisted subnets.

要解决冲突，请打开配置文件，删除默认配置文件，然后再次运行 atlas auth login。

5

使用--projectId 和--orgId 标志发出命令。

当您在 Atlas CLI 会话期间运行 Atlas CLI 命令时，请使用 --projectId 和 --orgId 标志指定您的项目 ID 和组织 ID。

例子

atlas alerts list --projectId 60b3c81153cf986293e2608b
1

运行身份验证命令。

在终端中运行 atlas config init 命令。

atlas config init
2

输入您的 API 密钥。

根据提示输入公钥和私钥。

3

接受默认配置文件选项。

当显示以下选项时，按Enter接受剩余的默认配置文件选项：

  • Default Org ID

  • Default Project ID

  • Default Output Format

  • Default MongoDB Shell Path

4

使用--projectId 和--orgId 标志发出命令。

当您在 Atlas CLI 会话期间运行 Atlas CLI 命令时，请使用 --projectId 和 --orgId 标志指定您的项目 ID 和组织 ID。

例子

atlas alerts list --projectId 60b3c81153cf986293e2608b

采取后续步骤

开始使用 Atlas CLI 命令。

要通过修改默认配置文件或创建不同的配置文件来保存连接设置，请参阅保存连接设置。

后退

验证包