App Services CLI

Overview

借助 Atlas App Services 命令行界面 (appservices)，您可以以编程方式管理应用程序。

通过 App Services CLI，您可以从本地目录创建或更新应用，以及将现有应用程序导出到本地目录。

安装

App Services CLI在npm上可用。 要在系统上安装CLI ，请确保您有 Node.js，然后在shell中运行以下命令：

npm install -g atlas-app-services-cli

身份验证

要使用 App Services CLI，必须进行身份验证。要进行身份验证，您必须生成 API 密钥。

生成 API 密钥

1

导航到 MongoDB Cloud Access Manager

MongoDB Cloud Access Manager允许您管理用户、团队和 API 密钥对项目的访问权限。 要使用项目访问管理器，请单击屏幕左上角access manager dropdown上的 Project Access标签页。

点击放大

2

创建 API 密钥

项目用户可以使用项目 API 密钥登录。单击项目访问管理器右侧的灰色Create API Key按钮，创建项目 API 密钥。

点击放大

单击此按钮将导航至“创建 API 密钥”屏幕。为密钥设置描述。

对于写入访问，CLI 需要具有“项目所有者”权限的 API 密钥。对于只读访问，可以使用“项目只读”。使用 Project Permissions（项目权限）下拉列表为您的用例选择适当的权限。

复制公钥，以便以后登录时使用。单击 next，继续配置密钥详细信息。

点击放大

3

配置 API 访问列表

将私钥复制到安全位置以备日后使用。出于安全目的，初始化后，私钥将不再可见。另一个安全功能是 API 访问列表。创建 API 访问列表条目可确保 API 调用源自允许的 IP。

必须提供使用该 API 密钥的用户的 IP 地址，才能使用该密钥。点击 Add Access List Entry 按钮。键入 IP 地址或点击 Use Current IP Address 按钮并点击保存。最后，单击屏幕右下角的完成按钮以完成 API 密钥的设置。

点击放大

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"

you have successfully logged in as <your public key>

目录.mdb

使用 App Services CLI 推送或提取配置文件时，CLI 会将有关您正在使用的应用的信息存储在应用程序配置的 .mdb 目录中。这使 CLI 能够在多个命令中记住与配置文件相关的具体部署。

此目录是计算机生成的，通常不应手动修改它。如果删除 .mdb 目录，则 CLI 将无法再将配置文件与特定部署相关联。运行针对特定部署的命令时，CLI 会创建一个新的 .mdb 目录。

CLI 将标识符和配置元数据存储在 .mdb/meta.json 文件中，其格式如下：

{
  "config_version": 20230101,
  "app_id": "42249d526d97af5a287c1eae",
  "group_id": "4b2cf422930196872221a2d4",
  "client_app_id": "myapp-abcde"
}

CLI 配置文件

CLI 将有关其用户的信息存储在配置文件中。这让您可以在给定上下文中运行命令。例如，使用 Atlas Admin API 密钥登录时，CLI 会存储 API 密钥和当前会话访问令牌。然后，它会在后续命令中重复使用该令牌，直至其过期。

您可以设置多个命名配置文件并选择一个配置文件用于任何给定的 CLI 命令。如果未指定，CLI 将使用默认配置文件，即名为 default 的配置文件。

要指定配置文件，请在任何命令上添加 --profile 参数。例如，要使用名为 my-profile 的新配置文件登录，请运行以下命令：

appservices login --profile my-profile

登录后，您可以使用相同的配置文件运行其他命令：

appservices pull --remote=myapp-abcde --profile my-profile

您可以使用 CLI 命令列出系统中的所有配置文件：

appservices profiles list

Found 2 profile(s)
  Profile     API Key
  ----------  -----------------------------------------------
  my-profile  rjxerfwi (********-****-****-****-f00b471ec015)
  default     xkwwtlmj (********-****-****-****-f03b321dae23)

CLI 将配置文件存储在计算机上以配置文件命名的单独配置文件中。配置文件定义的位置取决于您的系统：

选项

相关命令

• appservices accessList — 管理应用允许的 IP 地址和 CIDR 区块（别名：accesslist、access-list）

• appservices 应用 - 管理与当前用户关联的 App Service 应用（别名：应用）

• appservices deploy — 管理应用自动部署

• appservices function — 与应用的函数交互（别名：functions）

• appservices 登录 - 使用 MongoDB Cloud API 密钥将 CLI 登录到 App Services

• appservices logout - 将 CLI 从 App Services 中注销

• appservices 日志 - 与应用程序日志交互（别名：日志）

• appservices pull — 将最新版本的应用拉取到本地目录中

• appservices push — 将更改从本地目录推送并部署到应用

• appservices schema- 管理应用程序的模式（别名：模式）

• appservices secrets - 管理应用的密钥（别名：密钥）

• appservices users — 管理应用程序的用户（别名：user）

• appservices whoami - 显示有关当前用户的信息