配置 MongoDB CLI

在此页面上

先决条件

步骤
后续步骤

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

先决条件

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

将 IP或CIDR区块添加到 MongoDB 服务的API访问列表。
如果您还没有编程 API 密钥，请生成一个。
注意
编程 API 密钥基于角色。不同的角色具有不同的权限和能力，并且有些角色可以使用某些 MongoDB CLI 命令，有些则不行。请确保为您的编程 API 密钥分配的角色适合您打算使用的命令。
要了解有关为 MongoDB 服务生成编程 API Key 的更多信息，请参阅以下文档：
如果您的 MongoDB CLI 安装在防火墙后面并且您想使用代理 URL ，请设置或环境变量。HTTP_PROXYHTTPS_PROXYMongoDB CLI 支持http 、 https和socks5方案。此外，在代理服务的访问列表中指定cloud.mongodb.com/作为主要目标 URL。如果您的代理配置启用了身份验证，则还必须指定用户名和密码。
要了解详情，请参阅代理服务器。

步骤

向 Atlas 进行身份验证。

运行 mongocli auth login 命令：
```
mongocli auth login
```
该命令会打开一个浏览器窗口，并返回一个一次性激活码。此激活码会在 10 分钟后过期。
如果您尚未登录，请在浏览器中登录您的 Atlas 帐户。
将激活代码粘贴到浏览器中，然后单击 Confirm Authorization 。

创建配置文件。

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

选择您的默认组织。

选择您的组织。
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

选择您的默认项目。

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

选择默认输出格式。

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

? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json

选项	说明
`plaintext`	可读的输出，包括 MongoDB CLI 返回的所有字段。
`json`	JSON 输出，包括 MongoDB CLI 返回的所有字段。

按 Enter。

指定系统上 MongoDB Shell`mongosh` 的路径。

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

指定系统中 mongosh 的路径。
```
? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
```
按 Enter。

可选：将 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 密钥。

验证您的个人资料。

查看配置文件运行 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

向MongoDB Cloud Manager

运行 mongocli auth login 命令：
```
mongocli auth login --cm
```
该命令会打开一个浏览器窗口，并返回一个一次性激活码。此激活码会在 10 分钟后过期。
如果您尚未登录，请在浏览器中登录您的MongoDB Cloud Manager帐户。
将激活码粘贴到浏览器中，然后单击 Confirm Authorization。

创建配置文件。

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

选择您的默认组织。

选择您的组织。
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

选择您的默认项目。

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

选择默认输出格式。

按 Down Arrow 和 Up Arrow 键突出显示所需的默认输出格式：
```
? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json
```
选项
说明
plaintext
可读的输出，包括 MongoDB CLI 返回的所有字段。
json
JSON 输出，包括 MongoDB CLI 返回的所有字段。
按 Enter。

指定系统上 MongoDB Shell`mongosh` 的路径。

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

指定系统中 mongosh 的路径。

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

按 Enter。

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

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

注意

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

验证您的个人资料。

查看配置文件运行 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

完成先决条件。

在配置 MongoDB CLI 之前：

将您的IP或CIDR块添加到 Ops Manager 的API访问列表。
如果您还没有编程 API 密钥，请生成一个。

注意

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

创建配置文件。

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

运行mongocli 配置命令：

mongocli config --service ops-manager

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

运行mongocli 配置命令：

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

输入用于访问 Ops Manager 的 URL 。

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

可选：输入您的 API 密钥。

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

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

选择您的默认组织。

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

选择您的组织。
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

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

选择您的默认项目。

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

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

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

选择默认输出格式。

按 Down Arrow 和 Up Arrow 键突出显示所需的默认输出格式：
```
? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json
```
选项
说明
plaintext
可读的输出，包括 MongoDB CLI 返回的所有字段。
json
JSON 输出，包括 MongoDB CLI 返回的所有字段。
按 Enter。

指定系统上 MongoDB Shell`mongosh` 的路径。

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

指定系统中 mongosh 的路径。

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

按 Enter。

验证您的个人资料。

查看配置文件运行 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

后续步骤

编辑配置文件以添加或修改配置文件。
设置环境变量以简化脚本编写。
启用自动完成功能，可直接在 shell 中查看可用命令及其事务语法。

后退

验证包

来年

MongoDB CLI 配置文件

配置 MongoDB CLI.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-1l4s55v{margin-top:-175px;position:absolute;padding-bottom:2px;}

先决条件

注意

步骤

向 Atlas 进行身份验证。

创建配置文件。

选择您的默认组织。

选择您的默认项目。

选择默认输出格式。

指定系统上 MongoDB Shellmongosh 的路径。

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

注意

验证您的个人资料。

例子

例子

向MongoDB Cloud Manager进行身份验证。

创建配置文件。

选择您的默认组织。

选择您的默认项目。

选择默认输出格式。

指定系统上 MongoDB Shellmongosh 的路径。

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

注意

验证您的个人资料。

例子

例子

完成先决条件。

注意

创建配置文件。

输入 用于访问 Ops Manager 的 URL 。

可选：输入您的 API 密钥 。

选择您的默认组织。

选择您的默认项目。

选择默认输出格式。

指定系统上 MongoDB Shellmongosh 的路径。

验证您的个人资料。

例子

例子

后续步骤

配置 MongoDB CLI

指定系统上 MongoDB Shell`mongosh` 的路径。

向MongoDB Cloud Manager

指定系统上 MongoDB Shell`mongosh` 的路径。

输入用于访问 Ops Manager 的 URL 。

可选：输入您的 API 密钥。

指定系统上 MongoDB Shell`mongosh` 的路径。