Docs 菜单
Docs 主页
/ /
Atlas App Services

创建 App Services App

在此页面上

  • Overview
  • 开始之前
  • 步骤

您可以从 App Services UI、CLI 或 Admin API 创建新的 App Services App。

App Services App 是一个托管后端实例,其中包含应用程序的服务。每个应用都属于一个特定的 Atlas 项目。

要在项目中创建应用,您必须登录 MongoDB Atlas并拥有项目所有者权限。

要在 Atlas 用户界面中创建应用,您需要具备以下条件:

  • 具有项目所有者权限的 MongoDB Atlas 帐户。要了解如何注册免费帐户,请参阅开始使用 Atlas

要在 CLI 中创建应用,您需要满足以下条件:

  • 具有项目所有者权限的 MongoDB Atlas 帐户。要了解如何注册免费帐户,请参阅开始使用 Atlas

  • MongoDB Atlas Admin API公钥/私钥对。 API 密钥必须具有项目所有者权限才能使用 App Services Admin API。

  • 已安装 App Services CLI 副本,并将其添加到本地系统 PATH 中。要了解操作方法,请参阅安装 App Services CLI

要使用 Admin API 创建应用,您需要满足以下条件:

1

在 Atlas 用户界面项目仪表盘中,单击 App Services标签页。

2

您可以创建一个新的空白应用,也可以从已为您预先配置一些服务的模板开始。一些模板应用还附带相应的客户端应用程序。

要了解详情,请参阅模板应用

如果项目中没有应用,系统将提示您从模板创建新应用或从头开始创建。

否则,您可以在 App Services 标签页右上角的两个创建按钮之间进行选择:

  • 要创建空白应用,请单击 Create a New App 按钮。

  • 要使用模板,请单击 Create App from Template,然后从下拉菜单中选择模板。

3

用户界面会提示您配置以下设置:

  • 应用程序名称。您的应用名称是公开的,并包含在客户端使用的 App ID 中。

    注意

    应用名称限制

    应用程序名称必须介于 1 到 32 个字符之间,并且仅包含 ASCII 字母、数字、下划线和连字符。

  • 链接的数据源。这是应用可以访问的 Atlas 集群。如果项目没有集群,可以让 App Services 自动创建一个集群。

    注意

    需要 MongoDB 5.0 或更高版本

    Atlas Device Sync 需要运行 MongoDB 5版本的 Atlas 集群。 0或更高版本。设置集群时,请从Additional Settings下的下拉菜单中选择版本。

您还可在 Advanced Configuration 下配置以下可选设置:

  • 应用程序区域决定应用的执行位置及其元数据的存储位置。要了解详情,请参阅部署模式和区域

  • 决定使用哪些环境值的应用环境。要了解详情,请参阅配置应用环境。

4

配置应用后,单击 Create App Service

创建应用后,Atlas 用户界面会自动将您重定向到 App Services Admin 用户界面。

1

使用 MongoDB Atlas Admin API 密钥登录到 CLI:

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

CLI 可以使用单个命令创建应用程序并将其配置文件复制到本地目录。 该命令要求您指定应用名称以及应包含该应用的 Atlas 项目。 您可以使用标志或以交互方式配置该命令。

appservices apps create

该命令还支持其他标志,您可以选择包含这些标志来自定义您的应用程序。 下表列出了您可能会使用的常见标志:

--template

选择要启动的应用模板。如果不指定模板,该命令将创建一个空白应用。

有关所有模板应用的列表,请参阅可用模板应用。

--deployment-model

定义应用的部署模型。

Valid values:

  • GLOBAL

  • LOCAL

--provider-region

定义应用的部署地区。

有关可用地区的列表,请参阅云部署地区。

--environment

设置应用的环境标签。

Valid values:

  • development

  • testing

  • qa

  • production

提示

另请参阅:

有关更多详细信息和其他标志,请参阅create 命令的 CLI 文档。

1

使用您的 MongoDB Atlas API 密钥对调用管理员用户身份验证端点:

curl -X POST \
https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"username": "<Public API Key>",
"apiKey": "<Private API Key>"
}'

如果身份验证成功,响应正文将包含一个具有access_token值的 JSON 对象:

{
"access_token": "<access_token>",
"refresh_token": "<refresh_token>",
"user_id": "<user_id>",
"device_id": "<device_id>"
}

access_token授予对 Atlas App Services Admin API 的访问权限。您必须将其作为持有者令牌包含在所有 Admin API 请求的Authorization标头中。

提示

另请参阅:

2

每个 App Services App 都属于一个 MongoDB Atlas 项目。

要创建应用程序,您需要包含该应用程序的 MongoDB Atlas 项目的项目 ID(有时称为群组 ID)。 您将在 API 请求的 URL 中包含此 ID。

3

您可以通过创建应用端点创建新应用。

您的请求必须包括:

curl -X POST \
https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
--header 'Authorization: Bearer <access_token>' \
--data '{ "name": "<App Name>" }'

如果要从模板创建应用,还必须在请求正文中包含以下内容:

  • template_id包含可用模板应用之一的字段。有关所有模板应用的列表,请参阅 可用模板应用。

  • data_source字段,其中包含现有 Atlas 集群的信息。

    curl -X POST \
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
    -H 'Authorization: Bearer <access_token>' \
    -d '{
    "name": "<App Name>",
    "template_id": "<Template App Id>",
    "data_source": {
    "name": "mongodb-atlas",
    "type": "mongodb-atlas",
    "config": {
    "clusterName": "<Atlas Cluster Name>"
    }
    }
    }'

如果应用创建成功,该 API 将返回201响应,其中包含有关新应用的信息。

来年

什么是 Atlas App Services?