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

配置 MongoDB CLI

在此页面上

  • 先决条件
  • 步骤
  • 后续步骤

您可以使用 mongocli auth login 或 mongocli config 命令定义 用于与MongoDB CLI MongoDB、 和 等 服务交互的设置。AtlasCloud ManagerMongoDB Ops Manager首次运行这些命令时， MongoDB CLI会创建一个名为 config.toml的配置文件来存储您的设置。

先决条件

要配置 MongoDB CLI，请执行以下操作：

  • 将 IP或CIDR区块添加到 MongoDB 服务的API访问列表。

  • 如果您还没有编程 API 密钥，请生成一个。

    注意

    编程 API 密钥基于角色。不同的角色具有不同的权限和能力，并且有些角色可以使用某些 MongoDB CLI 命令，有些则不行。请确保为您的编程 API 密钥分配的角色适合您打算使用的命令。

    要了解有关为 MongoDB 服务生成编程 API Key 的更多信息，请参阅以下文档：

    • Atlas API Access

    • Cloud Manager API 访问

    • Ops Manager API 访问

  • 如果您的 MongoDB CLI 安装在防火墙后面并且您想使用代理 URL ，请设置 或 环境变量 。HTTP_PROXYHTTPS_PROXYMongoDB CLI 支持http 、 https和socks5方案。 此外，在代理服务的访问列表中指定cloud.mongodb.com/作为主要目标 URL。 如果您的代理配置启用了身份验证，则还必须指定用户名和密码。

    要了解详情，请参阅 代理服务器。

步骤

1

向 Atlas 进行身份验证。

  1. 运行 mongocli auth login 命令：

    mongocli auth login

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

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

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

2

创建配置文件。

在终端中，按Enter default以在 MongoDB CLI配置文件 中创建名为 的 配置 文件。

3

选择您的默认组织。

  1. 选择您的组织。

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者

    • 键入组织名称来过滤可用的组织。

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. 按 Enter。

4

选择您的默认项目。

  1. 选择您的项目：

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者

    • 输入项目名称以筛选可用项目。

    ? Choose a default project:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. 按 Enter。

5

选择默认输出格式。

  1. 按 Down Arrow 和 Up Arrow 键突出显示所需的默认输出格式：

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    选项
    说明
    plaintext
    可读的输出，包括 MongoDB CLI 返回的所有字段。
    json
    JSON 输出，包括 MongoDB CLI 返回的所有字段。

  2. 按 Enter。

6

指定系统上MongoDB Shellmongosh 的路径。

MongoDB CLI 使用指定的 mongosh 路径，以便您访问部署。默认值为 /usr/local/bin/mongosh。按 Enter 接受默认设置或：

  1. 指定系统中 mongosh 的路径。

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. 按 Enter。

7

可选：将 API 密钥添加到您的配置文件。

身份验证成功后，您将在 MongoDB CLI 中保持登录状态 12 小时。对于需要超过 12 小时的编程访问的帐户，请使用 mongocli config set 命令为配置文件配置 API 密钥：

mongocli config set public_api_key abcdef
mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d

注意

编程 API 密钥是基于角色的。不同的角色具有不同的权限和能力，一些 MongoDB CLI 命令可供某些角色使用，但其他角色不可用。请务必为编程 API 密钥分配适合您打算使用的命令的角色。

要了解有关为 Atlas 生成 API 密钥的更多信息，请参阅编程 API 密钥。

8

验证您的个人资料。

查看配置文件 运行 mongocli config describe 命令以验证您的配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud
1

向MongoDB Cloud Manager进行身份验证。

  1. 运行 mongocli auth login 命令：

    mongocli auth login --cm

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

  2. 如果您尚未登录，请在浏览器中登录您的MongoDB Cloud Manager帐户。

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

2

创建配置文件。

在终端中，按 Enter 在 MongoDB CLI 配置文件中创建名为 default 的配置文件。

3

选择您的默认组织。

  1. 选择您的组织。

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者

    • 键入组织名称来过滤可用的组织。

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. 按 Enter。

4

选择您的默认项目。

  1. 选择您的项目：

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者

    • 输入项目名称以筛选可用项目。

    ? Choose a default project:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. 按 Enter。

5

选择默认输出格式。

  1. 按 Down Arrow 和 Up Arrow 键突出显示所需的默认输出格式：

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    选项
    说明
    plaintext
    可读的输出，包括 MongoDB CLI 返回的所有字段。
    json
    JSON 输出，包括 MongoDB CLI 返回的所有字段。

  2. 按 Enter。

6

指定系统上MongoDB Shellmongosh 的路径。

MongoDB CLI 使用指定的 mongosh 路径，以便您访问部署。默认值为 /usr/local/bin/mongosh。按 Enter 接受默认设置或：

  1. 指定系统中 mongosh 的路径。

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. 按 Enter。

7

可选：将 API 密钥添加到您的配置文件。

身份验证成功后，您将在 MongoDB CLI 中保持登录状态 12 小时。对于需要超过 12 小时的编程访问的帐户，请使用 mongocli config set 命令为配置文件配置 API 密钥：

mongocli config set public_api_key abcdef
mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d

注意

编程 API 密钥是基于角色的。不同的角色具有不同的权限和能力，一些 MongoDB CLI 命令可供某些角色使用，但其他角色不可用。请务必为编程 API 密钥分配适合您打算使用的命令的角色。

要了解有关为MongoDB Cloud Manager生成 API 密钥的更多信息，请参阅API 密钥。

8

验证您的个人资料。

查看配置文件 运行 mongocli config describe 命令以验证您的配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud-manager

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud-manager
1

完成先决条件。

在配置MongoDB CLI之前：

  1. 将您的IP 或 CIDR 区块添加到API 的MongoDB Ops Manager 访问权限列表。

  2. 如果您还没有编程 API 密钥，请生成一个。

注意

编程 API 密钥是基于角色的。不同的角色具有不同的权限和能力，一些 MongoDB CLI 命令可供某些角色使用，但其他角色不可用。请务必为编程 API 密钥分配适合您打算使用的命令的角色。

要学习；了解有关为 生成编程API MongoDB Ops Manager密钥的更多信息，请参阅MongoDB Ops ManagerAPI 访问权限。

2

创建配置文件。

此命令在 MongoDB CLI配置文件 中 创建一个名为 的配置文件。default

运行mongocli 配置命令：

mongocli config --service ops-manager

此命令在 MongoDB CLI配置文件中创建具有自定义名称的配置文件 。要在命令中使用此配置文件，必须使用--profile标志指定该配置文件。

运行mongocli 配置命令：

mongocli config --service ops-manager --profile <profile-name>
3

URLMongoDB Ops Manager输入用于访问权限MongoDB Ops Manager的URL 。

? URL to Access Ops Manager: http://mms.example.com:8080/
4

可选：输入您的API密钥。

出现提示时，输入MongoDB Ops Manager部署的 Public API Key 和 Private API Key。

? Public API Key: [? for help] abcdef
? Private API Key: [? for help]
************************************
5

选择您的默认组织。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的组织的名称和ID 。

  1. 选择您的组织。

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者

    • 键入组织名称来过滤可用的组织。

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. 按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Organization ID 。

6

选择您的默认项目。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的项目的名称和ID 。

  1. 选择您的项目：

    • 按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者

    • 输入项目名称以筛选可用项目。

    ? Default Project ID:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. 按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Project ID 。

7

选择默认输出格式。

  1. 按 Down Arrow 和 Up Arrow 键突出显示所需的默认输出格式：

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    选项
    说明
    plaintext
    可读的输出，包括 MongoDB CLI 返回的所有字段。
    json
    JSON 输出，包括 MongoDB CLI 返回的所有字段。

  2. 按 Enter。

8

指定系统上MongoDB Shellmongosh 的路径。

MongoDB CLI 使用指定的 mongosh 路径，以便您访问部署。默认值为 /usr/local/bin/mongosh。按 Enter 接受默认设置或：

  1. 指定系统中 mongosh 的路径。

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. 按 Enter。

9

验证您的个人资料。

查看配置文件 运行 mongocli config describe 命令以验证您的配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
ops_manager_url = https://mms.example.com:8080/
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           ops-manager

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

SETTING           VALUE
ops_manager_url = https://mms.example.com:8080/
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           ops-manager

后续步骤

后退

验证包

来年

配置文件