“文档” 菜单
文档首页
/
MongoDB 阿特拉斯
/
Atlas
/
流程自动化

Atlas CLI 环境变量

在此页面上

  • 优先级
  • 支持的环境变量

为了简化脚本编写，可以使用环境变量指定配置设置。

优先级

  • 运行任何命令时，使用环境变量指定的每个设置都优先于配置文件中存储的配置文件。

  • 当您使用 --projectId 选项运行命令时，命令行选项优先于环境变量和配置文件中存储的配置。

支持的环境变量

重要

Atlas CLI 同时支持 MongoDB CLI 环境变量和 Atlas CLI 环境变量。 您可以使用 MongoDB CLI 环境变量或 Atlas CLI 环境变量，但不能同时使用两者。

Atlas CLI 支持以下环境变量：

变量
说明
DO_NOT_TRACK

指示是否为 Atlas CLI 禁用遥测的标志。 设置为1以禁用遥测。

您还可以使用MONGODB_ATLAS_TELEMETRY_ENABLED启用或禁用遥测，但不需要同时指定两者。

MONGODB_ATLAS_PUBLIC_API_KEY
为与 Atlas 交互的命令设置公共 API密钥。
MONGODB_ATLAS_PRIVATE_API_KEY
为与 Atlas 交互的命令设置私有API密钥。
MONGODB_ATLAS_ORG_ID
为需要 --orgId 选项的命令设置组织 ID。
MONGODB_ATLAS_PROJECT_ID
为需要 --projectId 选项的命令设置项目 ID。
MONGODB_ATLAS_OUTPUT

设置输出字段和格式。有效值为：

值
输出格式
Empty
default
人类可读的输出，包括 Atlas CLI 返回的所有字段。
json
JSON 输出，包括 Atlas CLI 返回的所有字段。
json-path
包含您指定的字段的 JSON 输出。
go-template
自定义格式的输出，其中包括您在 Go 模板中指定的字段。
MONGODB_ATLAS_MONGOSH_PATH
本地系统上 MongoDB Shell mongosh的完整路径。
MONGODB_ATLAS_SKIP_UPDATE_CHECK
设置为yes时，Atlas CLI 不会提示您更新到新版本。
MONGODB_ATLAS_ACCESS_TOKEN
授予 Atlas 帐户访问权限的字符串。 访问令牌的有效期为 12 小时。
MONGODB_ATLAS_REFRESH_TOKEN
允许 Atlas 在当前访问令牌过期时自动请求新访问令牌的字符串。
MONGODB_ATLAS_TELEMETRY_ENABLED

指示是否为 Atlas CLI 启用遥测的标志。 设置为false以禁用遥测。

您还可以使用DO_NOT_TRACK启用或禁用遥测，但不需要同时指定两者。

HTTP_PROXY

绝对 URL 或主机名和端口，采用 hostname[:port] 格式。

例子

以下示例展示了如果代理配置不要求身份验证，如何设置环境变量。

HTTP_PROXY=<my.proxy.address>

以下示例展示了在代理配置要求身份验证时如何设置环境变量。

HTTP_PROXY=<username>:<password>@<my.proxy.address>

以下示例展示了如果模式为 socks5，如何设置环境变量。

HTTP_PROXY=socks5://<my.proxy.address>
HTTPS_PROXY

绝对 URL。如果还设置了 HTTP_PROXY，则针对所有请求，它优先于 HTTP_PROXY。

例子

以下示例展示了如何设置环境变量。

HTTPS_PROXY=https://<my.proxy.address>
NO_PROXY
表示该 URL 没有对应的代理，因为没有为该 URL 配置代理。

后退

流程自动化

来年

自定义输出

在此页面上