选择连接方法
当您从 Atlas CLI 连接到现有 Atlas 帐户时,您可以使用以下命令之一进行身份验证:
命令 | 身份验证方法 | 用例(Use Case) |
---|---|---|
| Atlas 登录凭证和身份验证令牌 | 最适合非编程使用 |
| 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
标志。
You must configure API keys to authenticate with this command.
运行 atlas config init
命令时,Atlas CLI 会提示您提供 API 密钥,并自动创建一个存储 API 密钥的配置文件。atlas config init
最适合以编程方式使用,因为它不需要手动登录或令牌验证。
使用 atlas config init
连接时,您可以:
按照最低设置要求进行连接,并在每个命令中指定
--projectId
和--orgId
标志。这是首次登录的最快开始方式。将其他连接设置保存在配置文件中。配置文件存储项目 ID 和组织 ID,以及可选的 API 密钥,以便在将来的 Atlas CLI 会话中使用。为了节省时间,您可以指定配置文件,而不是在每个命令中使用
--projectId
和--orgId
标志。
使用最少必要设置进行连接
选择一个使用案例,按照步骤以所需的最低设置从 Atlas CLI 进行连接。
满足先决条件
Add your host's IP address to the IP access list.
如果您使用Atlas user IP档案进行身份验证,并且组织所有者为组织启用 了 用户界面的 访问列表,则Atlas IP必须将您的 地址添加到IP 访问列表才能运行该组织中的命令。要了解更多信息,请参阅Atlas 用户界面需要 IP 访问列表。
按照以下步骤操作
选择一个使用案例并按照步骤从 Atlas CLI 进行快速连接。
使用--projectId
和--orgId
标志发出命令。
当您在 Atlas CLI 会话期间运行 Atlas CLI 命令时,请使用 --projectId
和 --orgId
标志指定您的项目 ID 和组织 ID。
例子
atlas alerts list --projectId 60b3c81153cf986293e2608b
使用--projectId
和--orgId
标志发出命令。
当您在 Atlas CLI 会话期间运行 Atlas CLI 命令时,请使用 --projectId
和 --orgId
标志指定您的项目 ID 和组织 ID。
例子
atlas alerts list --projectId 60b3c81153cf986293e2608b
采取后续步骤
开始使用 Atlas CLI 命令。
要通过修改默认配置文件或创建不同的配置文件来保存连接设置,请参阅保存连接设置。